Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

Creaate a button to add new widgets

Henriette Darge4338c11fbae4
diff --git a/config/locales/en.yml b/config/locales/en.yml
index 46251b2eec9..d3b7f086ae4 100644
--- a/config/locales/en.yml
+++ b/config/locales/en.yml
@@ -3388,6 +3388,8 @@ en:
label_watched_work_packages: "Watched work packages"
label_what_is_this: "What is this?"
label_week: "Week"
+ label_widget: "Widget"
+ label_widget_new: "New widget"
label_wiki_content_added: "Wiki page added"
label_wiki_content_updated: "Wiki page updated"
label_wiki_toc: "Table of Contents"
diff --git a/frontend/src/app/shared/components/grids/grid/add-widget.service.ts b/frontend/src/app/shared/components/grids/grid/add-widget.service.ts
index 20b9534f459..16794bccd19 100644
--- a/frontend/src/app/shared/components/grids/grid/add-widget.service.ts
+++ b/frontend/src/app/shared/components/grids/grid/add-widget.service.ts
@@ -1,4 +1,8 @@
-import { Injectable, Injector } from '@angular/core';
+import {
+ Injectable,
+ Injector,
+ OnDestroy,
+} from '@angular/core';
import { OpModalService } from 'core-app/shared/components/modal/modal.service';
import { AddGridWidgetModalComponent } from 'core-app/shared/components/grids/widgets/add/add.modal';
import { GridWidgetResource } from 'core-app/features/hal/resources/grid-widget-resource';
@@ -14,9 +18,11 @@ import { I18nService } from 'core-app/core/i18n/i18n.service';
import { GridResource } from 'core-app/features/hal/resources/grid-resource';
@Injectable()
-export class GridAddWidgetService {
+export class GridAddWidgetService implements OnDestroy {
text = { add: this.i18n.t('js.grid.add_widget') };
+ private boundListener = this.createNewWidget.bind(this);
+
constructor(
readonly opModalService:OpModalService,
readonly injector:Injector,
@@ -27,6 +33,11 @@ export class GridAddWidgetService {
readonly resize:GridResizeService,
readonly i18n:I18nService,
) {
+ document.addEventListener('overview:addWidget', this.boundListener);
+ }
+
+ ngOnDestroy():void {
+ document.removeEventListener('overiew:addWidget', this.boundListener);
}
public isAddable(area:GridArea) {
@@ -126,4 +137,9 @@ export class GridAddWidgetService {
public get isAllowed() {
return this.layout.gridResource && this.layout.gridResource.updateImmediately;
}
+
+ private createNewWidget():void {
+ const newGap = new GridGap(1, 2, 1, 2, 'row');
+ void this.widget(newGap);
+ }
}
diff --git a/frontend/src/stimulus/controllers/dynamic/overview/add-widgets.controller.ts b/frontend/src/stimulus/controllers/dynamic/overview/add-widgets.controller.ts
new file mode 100644
index 00000000000..14f0b2264f8
--- /dev/null
+++ b/frontend/src/stimulus/controllers/dynamic/overview/add-widgets.controller.ts
@@ -0,0 +1,9 @@
+import { Controller } from '@hotwired/stimulus';
+
+export default class AddWidgetsController extends Controller {
+ private addWidget():void {
+ document.dispatchEvent(
+ new CustomEvent('overview:addWidget'),
+ );
+ }
+}
diff --git a/modules/overviews/app/views/overviews/overviews/show.html.erb b/modules/overviews/app/views/overviews/overviews/show.html.erb
index c51821e4eee..c5c1301ea89 100644
--- a/modules/overviews/app/views/overviews/overviews/show.html.erb
+++ b/modules/overviews/app/views/overviews/overviews/show.html.erb
@@ -55,4 +55,23 @@
end
%>
+<%=
+ if User.current.allowed_in_project?(:manage_overview, @project)
+ render(Primer::OpenProject::SubHeader.new) do |subheader|
+ subheader.with_action_button(
+ scheme: :primary,
+ leading_icon: :plus,
+ label: t(:label_widget_new),
+ data: {
+ controller: "overview--add-widgets",
+ action: "click->overview--add-widgets#addWidget"
+ },
+ test_selector: "overview--add-widgets-button"
+ ) do
+ t(:label_widget)
+ end
+ end
+ end
+%>
+
<openproject-base></openproject-base>
diff --git a/modules/overviews/spec/features/managing_overview_page_spec.rb b/modules/overviews/spec/features/managing_overview_page_spec.rb
index 5760ba3651b..3b4dffa191d 100644
--- a/modules/overviews/spec/features/managing_overview_page_spec.rb
+++ b/modules/overviews/spec/features/managing_overview_page_spec.rb
@@ -60,87 +60,155 @@ RSpec.describe "Overview page managing", :js, :selenium do
create(:user,
member_with_permissions: { project => permissions })
end
+
+ let(:user_without_permission) do
+ create(:user,
+ member_with_permissions: {
+ project => %i[
+ view_members
+ view_work_packages
+ add_work_packages
+ save_queries
+ manage_public_queries
+ ]
+ })
+ end
+
let(:overview_page) do
Pages::Overview.new(project)
end
- before do
- login_as user
+ context "as a user with permission" do
+ before do
+ login_as user
- overview_page.visit!
- end
+ overview_page.visit!
+ end
- it "renders the default view, allows altering and saving" do
- description_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(1)")
- status_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(2)")
- overview_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(3)")
- members_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(4)")
-
- description_area.expect_to_exist
- status_area.expect_to_exist
- overview_area.expect_to_exist
- members_area.expect_to_exist
- description_area.expect_to_span(1, 1, 3, 2)
- status_area.expect_to_span(1, 2, 2, 3)
- overview_area.expect_to_span(3, 1, 4, 3)
- members_area.expect_to_span(2, 2, 3, 3)
-
- # The widgets load their respective contents
- within description_area.area do
- expect(page)
- .to have_content("My custom description")
+ it "renders the default view, allows altering and saving" do
+ description_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(1)")
+ status_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(2)")
+ overview_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(3)")
+ members_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(4)")
+
+ description_area.expect_to_exist
+ status_area.expect_to_exist
+ overview_area.expect_to_exist
+ members_area.expect_to_exist
+ description_area.expect_to_span(1, 1, 3, 2)
+ status_area.expect_to_span(1, 2, 2, 3)
+ overview_area.expect_to_span(3, 1, 4, 3)
+ members_area.expect_to_span(2, 2, 3, 3)
+
+ # The widgets load their respective contents
+ within description_area.area do
+ expect(page)
+ .to have_content("My custom description")
+ end
+
+ # within top-left area, add an additional widget
+ overview_page.add_widget(1, 1, :row, "Work packages table")
+ # Actually there are two success messages displayed currently. One for the grid getting updated and one
+ # for the query assigned to the new widget being created. A user will not notice it but the automated
+ # browser can get confused. Therefore we dismiss it twice.
+ overview_page.expect_and_dismiss_toaster message: I18n.t("js.notice_successful_update")
+
+ # Fixing flaky spec: for some reason, the second request to load the table is not executed until
+ # some activity happens on the page. Sending an enter key to trigger the second request.
+ page.find("body").send_keys(:enter)
+
+ overview_page.expect_and_dismiss_toaster message: I18n.t("js.notice_successful_update")
+
+ table_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(5)")
+ table_area.expect_to_span(1, 1, 2, 2)
+
+ # A useless resizing shows no message and does not alter the size
+ table_area.resize_to(1, 1)
+
+ overview_page.expect_no_toaster message: I18n.t("js.notice_successful_update")
+
+ table_area.expect_to_span(1, 1, 2, 2)
+
+ table_area.resize_to(1, 2)
+
+ overview_page.expect_and_dismiss_toaster message: I18n.t("js.notice_successful_update")
+
+ # Resizing leads to the table area now spanning a larger area
+ table_area.expect_to_span(1, 1, 2, 3)
+
+ within table_area.area do
+ expect(page)
+ .to have_content(created_work_package.subject)
+ expect(page)
+ .to have_content(assigned_work_package.subject)
+ end
+
+ sleep(0.1)
+
+ # Reloading kept the user's values
+ visit home_path
+ overview_page.visit!
+
+ ## Because of the added column and the resizing the other widgets have moved down
+ # For unknown, undesired reasons, the project description no longer spans two rows.
+ # This happens when resizing the table area.
+ description_area.expect_to_span(2, 1, 3, 2)
+ status_area.expect_to_span(2, 2, 3, 3)
+ overview_area.expect_to_span(4, 1, 5, 3)
+ members_area.expect_to_span(3, 2, 4, 3)
+ table_area.expect_to_span(1, 1, 2, 3)
end
- # within top-left area, add an additional widget
- overview_page.add_widget(1, 1, :row, "Work packages table")
- # Actually there are two success messages displayed currently. One for the grid getting updated and one
- # for the query assigned to the new widget being created. A user will not notice it but the automated
- # browser can get confused. Therefore we dismiss it twice.
- overview_page.expect_and_dismiss_toaster message: I18n.t("js.notice_successful_update")
+ it "can add a new widget via a primary button" do
+ description_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(1)")
+ status_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(2)")
+ overview_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(3)")
+ members_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(4)")
- # Fixing flaky spec: for some reason, the second request to load the table is not executed until
- # some activity happens on the page. Sending an enter key to trigger the second request.
- page.find("body").send_keys(:enter)
+ description_area.expect_to_exist
+ status_area.expect_to_exist
+ overview_area.expect_to_exist
+ members_area.expect_to_exist
- overview_page.expect_and_dismiss_toaster message: I18n.t("js.notice_successful_update")
+ description_area.expect_to_span(1, 1, 3, 2)
+ status_area.expect_to_span(1, 2, 2, 3)
+ overview_area.expect_to_span(3, 1, 4, 3)
+ members_area.expect_to_span(2, 2, 3, 3)
- table_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(5)")
- table_area.expect_to_span(1, 1, 2, 2)
+ page.find_test_selector("overview--add-widgets-button").click
- # A useless resizing shows no message and does not alter the size
- table_area.resize_to(1, 1)
+ within(".spot-modal") do
+ expect(page).to have_content(I18n.t("js.grid.add_widget"))
- overview_page.expect_no_toaster message: I18n.t("js.notice_successful_update")
+ SeleniumHubWaiter.wait unless using_cuprite?
- table_area.expect_to_span(1, 1, 2, 2)
+ page.find('[data-test-selector="op-grid--addable-widget"]', text: "Members").click
+ end
- table_area.resize_to(1, 2)
+ second_members_area = Components::Grids::GridArea.new(".grid--area.-widgeted:nth-of-type(5)")
+ second_members_area.expect_to_span(1, 1, 2, 2)
- overview_page.expect_and_dismiss_toaster message: I18n.t("js.notice_successful_update")
+ description_area.expect_to_span(2, 1, 4, 2)
+ status_area.expect_to_span(1, 2, 3, 3)
+ overview_area.expect_to_span(4, 1, 5, 3)
+ members_area.expect_to_span(3, 2, 4, 3)
+ end
+ end
- # Resizing leads to the table area now spanning a larger area
- table_area.expect_to_span(1, 1, 2, 3)
+ context "as a user without permission" do
+ before do
+ login_as user_without_permission
- within table_area.area do
- expect(page)
- .to have_content(created_work_package.subject)
- expect(page)
- .to have_content(assigned_work_package.subject)
+ overview_page.visit!
end
- sleep(0.1)
+ it "does not show the option to add widgets" do
+ # Neither hover effects
+ overview_page.expect_unable_to_add_widget(1, 1, :column, nil)
+ overview_page.expect_unable_to_add_widget(1, 1, :row, nil)
- # Reloading kept the user's values
- visit home_path
- overview_page.visit!
-
- ## Because of the added column and the resizing the other widgets have moved down
- # For unknown, undesired reasons, the project description no longer spans two rows.
- # This happens when resizing the table area.
- description_area.expect_to_span(2, 1, 3, 2)
- status_area.expect_to_span(2, 2, 3, 3)
- overview_area.expect_to_span(4, 1, 5, 3)
- members_area.expect_to_span(3, 2, 4, 3)
- table_area.expect_to_span(1, 1, 2, 3)
+ # nor a create button are shown
+ expect(page).to have_no_test_selector("overview--add-widgets-button")
+ end
end
end