Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SAK-50053 WC permissions responsive ui improvements #12854

Merged
merged 1 commit into from
Sep 5, 2024
Merged

SAK-50053 WC permissions responsive ui improvements #12854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions library/src/skins/default/src/sass/tool.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ $page-header-border-color: lighten(#000, 46.7%) !default; // #eee
$jumbotron-heading-font-size: $h4-font-size;

@import "webcomponents/course-card/course-card";
@import "webcomponents/permissions/permissions";

@import "modules/more-sites/more-sites";
@import "modules/notifications/notifications";
Expand Down
35 changes: 35 additions & 0 deletions library/src/skins/default/src/sass/webcomponents/permissions/_permissions.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
#permissions-container {

margin-left: 0 !important;
margin-right: 0 !important;

border: 1px solid var(--sakai-border-color);

.row-hover {
background-color: var(--sakai-active-color-2);
}

.permission-row {

&:hover {
background-color: var(--sakai-active-color-2);
}

&:nth-child(odd) {
background-color: var(--sakai-table-even-color);
}

.permission-cell {
border-left: 1px solid var(--sakai-border-color);
}
}

#permission-header {
background-color: var(--sakai-background-color-2);

button {
color: var(--sakai-text-color-1);
}
}
}

100 changes: 56 additions & 44 deletions webcomponents/tool/src/main/frontend/packages/sakai-permissions/src/SakaiPermissions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { SakaiElement } from "@sakai-ui/sakai-element";
import { html } from "lit";
import { html, nothing } from "lit";
import "@sakai-ui/sakai-group-picker";

export class SakaiPermissions extends SakaiElement {
Expand Down Expand Up @@ -53,8 +53,8 @@ export class SakaiPermissions extends SakaiElement {

e.preventDefault();

const all = e.target.closest("tr").querySelectorAll("input");
const checked = e.target.closest("tr").querySelectorAll("input:checked");
const all = this.querySelectorAll(`input[data-perm='${e.target.dataset.perm}']`);
const checked = this.querySelectorAll(`input[data-perm='${e.target.dataset.perm}']:checked`);

if (checked.length < all.length || checked.length === 0) {
all.forEach(i => i.checked = true);
Expand All @@ -63,23 +63,15 @@ export class SakaiPermissions extends SakaiElement {
}
}

_handlePermissionMouseEnter() {
this.querySelectorAll(".permissions-table td.checkboxCell").forEach(td => td.classList.add("rowHover"));
}

_handlePermissionMouseLeave() {
this.querySelectorAll(".permissions-table td.checkboxCell").forEach(td => td.classList.remove("rowHover"));
}

_handlePermissionChange(e) {
e.target.closest("td").classList.toggle("active", e.target.checked);
e.target.closest("div").classList.toggle("active", e.target.checked);
}

_handleRoleHover(e, type) {

const role = e.target.dataset.role.replace(".", "\\.");
this.querySelectorAll(`td.${role.replace(" ", "_")}-checkbox-cell`).forEach(cell => {
cell.classList.toggle("rowHover", type === "mouseenter");
this.querySelectorAll(`div.${role.replace(" ", "_")}-checkbox-cell`).forEach(cell => {
cell.classList.toggle("row-hover", type === "mouseenter");
});
}

Expand All @@ -97,26 +89,26 @@ export class SakaiPermissions extends SakaiElement {

const role = e.target.dataset.role.replace(".", "\\.");

const anyChecked = this.querySelectorAll(`.permissions-table .${role.replace(" ", "_")}-checkbox-cell input:checked:not(:disabled)`).length > 0;
this.querySelectorAll(`.permissions-table .${role.replace(" ", "_")}-checkbox-cell input:not(:disabled)`).forEach(i => i.checked = !anyChecked);
const anyChecked = this.querySelectorAll(`#permissions-container .${role.replace(" ", "_")}-checkbox-cell input:checked:not(:disabled)`).length > 0;
this.querySelectorAll(`#permissions-container .${role.replace(" ", "_")}-checkbox-cell input:not(:disabled)`).forEach(i => i.checked = !anyChecked);
}

_handlePermissionClick(e) {

e.preventDefault();

const checked = this.querySelectorAll(".permissions-table input:checked");
const checked = this.querySelectorAll("#permissions-container input:checked");

this.querySelectorAll(".permissions-table input").forEach(input => {
this.querySelectorAll("#permissions-container input").forEach(input => {
input.checked = checked.length === 0;
});
}

firstUpdated() {

// Save the default selected
this.querySelectorAll(".permissions-table :checked").forEach(el => {
el.closest("td").classList.add("defaultSelected");
this.querySelectorAll("#permissions-container :checked").forEach(el => {
el.closest("div").classList.add("defaultSelected");
});
}

Expand All @@ -132,39 +124,55 @@ export class SakaiPermissions extends SakaiElement {
${this.groups && this.groups.length > 0 ? html`
<div>
<label for="permissons-group-picker">${this.i18n["per.lis.selectgrp"]}</label>
<sakai-group-picker id="permissions-group-picker" groups="${JSON.stringify(this.groups)}" @group-selected=${this._groupSelected}></sakai-group-picker>
<sakai-group-picker id="permissions-group-picker"
groups="${JSON.stringify(this.groups)}"
@group-selected=${this._groupSelected}>
</sakai-group-picker>
</div>
` : ""}
` : nothing }
<div class="mb-1 pt-3">
<button class="btn btn-secondary"
aria-label="${this.i18n["per.lis.restoredef"]}"
@click=${this._resetPermissions}>
${this.i18n["per.lis.restoredef"]}
</button>
</div>
<table class="permissions-table table table-hover table-striped listHier checkGrid specialLink"
cellspacing="0"
summary="${this.i18n["per.lis"]}"
border="0">
<tr>
<th id="permission" @mouseenter=${this._handlePermissionMouseEnter} @mouseleave=${this._handlePermissionMouseLeave}>
<button class="btn btn-transparent" title="${this.i18n["per.lis.head.title"]}" @click=${this._handlePermissionClick}>${this.i18n["per.lis.head"]}</button>
</th>

<div id="permissions-container" class="container mt-4">
<div id="permission-header" class="row flex-nowrap">
<div class="col-md-6 p-3">
<button class="btn btn-transparent"
title="${this.i18n["per.lis.head.title"]}"
@click=${this._handlePermissionClick}>
${this.i18n["per.lis.head"]}
</button>
</div>
${this.roles.map(role => html`
<th class="role" data-role="${role}" @mouseenter=${this._handleRoleMouseEnter} @mouseleave=${this._handleRoleMouseLeave}>
<button class="btn btn-transparent" title="${this.i18n["per.lis.role.title"]}" data-role="${role}" @click=${this._handleRoleClick}>${this.roleNameMappings[role]}</button>
</th>
`)}
</tr>
<div class="col-sm role d-none d-md-block p-3 text-center"
data-role="${role}"
@mouseenter=${this._handleRoleMouseEnter}
@mouseleave=${this._handleRoleMouseLeave}>
<button class="btn btn-transparent"
title="${this.i18n["per.lis.role.title"]}"
data-role="${role}"
@click=${this._handleRoleClick}>
${this.roleNameMappings[role]}
</button>
</div>
`)}
</div>
${this.available.map(perm => html`
<tr>
<td class="text-start text-nowrap permissionDescription unclicked">
<button class="btn btn-transparent" title="${this.i18n["per.lis.perm.title"]}" @click=${this._handleDescriptionClick}>
<div class="row permission-row">
<div class="col-md-6 p-3 fw-bolder fw-md-normal">
<button class="btn btn-transparent fw-bolder fw-md-normal"
title="${this.i18n["per.lis.perm.title"]}"
data-perm="${perm}"
@click=${this._handleDescriptionClick}>
${this.i18n[perm]}
</button>
</td>
</div>
${this.roles.map(role => html`
<td class="${role.replace(" ", "_")}-checkbox-cell checkboxCell">
<div class="col-md ${role.replace(" ", "_")}-checkbox-cell text-start text-md-center p-3 permission-cell border-left-1">
<label for="${role}:${perm}" class="sr-only">
<span>${this.i18n["gen.enable"]} ${role}</span>
</label>
Expand All @@ -176,11 +184,15 @@ export class SakaiPermissions extends SakaiElement {
data-perm="${perm}"
@change=${this._handlePermissionChange}
id="${role}:${perm}"/>
</td>
<div class="d-inline-block d-md-none ms-1">
${this.roleNameMappings[role]}
</div>
</div>
`)}
</tr>
</div>
`)}
</table>
</div>

<div class="act">
<input type="button" class="active" value="${this.i18n["gen.sav"]}" aria-label="${this.i18n["gen.sav"]}" @click="${this._savePermissions}"/>
<input type="button" value="${this.i18n["gen.can"]}" aria-label="${this.i18n["gen.can"]}" @click="${this._completePermissions}"/>
Expand Down Expand Up @@ -223,7 +235,7 @@ export class SakaiPermissions extends SakaiElement {

document.body.style.cursor = "wait";

const boxes = this.querySelectorAll(".permissions-table input[type=\"checkbox\"]");
const boxes = this.querySelectorAll("#permissions-container input[type=\"checkbox\"]");
const params = `ref=${this.groupReference}&${ Array.from(boxes).reduce((acc, b) => {

if (b.checked) {
Expand Down
45 changes: 11 additions & 34 deletions ...mponents/tool/src/main/frontend/packages/sakai-permissions/test/sakai-permissions.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,6 @@ describe("sakai-permissions tests", () => {
.get(data.permsUrl, data.perms, { overwriteRoutes: true })
.get("*", 500, { overwriteRoutes: true });

/*
beforeEach(() => {


window.fetch = url => {

if (url === data.groupPickerI18nUrl) {
return Promise.resolve({ text: () => Promise.resolve(data.groupPickerI18n)});
} else if (url === data.permissionsI18nUrl) {
return Promise.resolve({ text: () => Promise.resolve(data.permissionsI18n)});
} else if (url === data.toolI18nUrl) {
return Promise.resolve({ text: () => Promise.resolve(data.toolI18n) });
} else if (url === data.groupsUrl) {
return Promise.resolve({ json: () => Promise.resolve(data.groups) });
} else if (url.startsWith(data.permsUrl)) {
return Promise.resolve({ json: () => Promise.resolve(data.perms) });
} else {
console.error(`Miss on ${url}`);
}
};
});
*/

it ("renders correctly", async () => {

const el = await fixture(html`<sakai-permissions tool="tool" site-id="${data.siteId}"></sakai-permissions>`);
Expand All @@ -48,22 +25,22 @@ describe("sakai-permissions tests", () => {

expect(el.querySelector("button:first-child").innerHTML).to.contain(el.i18n["per.lis.restoredef"]);

expect(el.querySelectorAll("table tr").length).to.equal(4);
expect(el.querySelectorAll("table tr:first-child th").length).to.equal(3);
expect(el.querySelectorAll("table tr:nth-child(2) input:checked").length).to.equal(2);
el.querySelector("table tr:nth-child(2) button").click();
expect(el.querySelectorAll("#permissions-container .row").length).to.equal(4);
expect(el.querySelectorAll("#permissions-container .row:first-child div").length).to.equal(3);
expect(el.querySelectorAll("#permissions-container .row:nth-child(2) input:checked").length).to.equal(2);
el.querySelector("#permissions-container .row:nth-child(2) button").click();
expect(el.querySelectorAll("table tr:nth-child(2) input:checked").length).to.equal(0);
el.querySelector("table tr:nth-child(2) button").click();
expect(el.querySelectorAll("table tr:nth-child(2) input:checked").length).to.equal(2);
el.querySelector("table button:first-child").click();
expect(el.querySelectorAll("table input:checked").length).to.equal(0);
el.querySelector("table button:first-child").click();
expect(el.querySelectorAll("table input:checked").length).to.equal(6);
el.querySelector("#permissions-container .row:nth-child(2) button").click();
expect(el.querySelectorAll("#permissions-container .row:nth-child(2) input:checked").length).to.equal(2);
el.querySelector("#permissions-container button:first-child").click();
expect(el.querySelectorAll("#permissions-container input:checked").length).to.equal(0);
el.querySelector("#permissions-container button:first-child").click();
expect(el.querySelectorAll("#permissions-container input:checked").length).to.equal(6);

// Reset the permissions
el.querySelector("button:first-child").click();
await el.updateComplete;
expect(el.querySelectorAll("table input:checked").length).to.equal(4);
expect(el.querySelectorAll("#permissions-container input:checked").length).to.equal(4);

expect(el.querySelectorAll(".access-checkbox-cell input:checked").length).to.equal(1);
el.querySelector("button[data-role='access']").click();
Expand Down
Loading