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

fix: multi project roles UI improvements #4646

Merged
merged 2 commits into from
Sep 8, 2023
Merged

fix: multi project roles UI improvements #4646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce67f73
fix: misc UI improvements for multi proj roles
nunogois Sep 7, 2023
965cc12
fix: improve design for role description
nunogois Sep 8, 2023
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
2 changes: 1 addition & 1 deletion frontend/src/component/admin/groups/GroupForm/GroupForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ export const GroupForm: FC<IGroupForm> = ({
<StyledInputDescription>
<Box sx={{ display: 'flex' }}>
Do you want to associate a root role with this group?
<HelpIcon tooltip="When you associate an Admin or Editor role with this group, users in this group will automatically inherit the role globally. Note that groups with a root role association cannot be assigned to projects." />
<HelpIcon tooltip="When you associate a root role with this group, users in this group will automatically inherit the role globally." />
</Box>
</StyledInputDescription>
<StyledAutocompleteWrapper>
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/component/admin/groups/GroupsList/GroupsList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const groupsSearch = (group: IGroup, searchValue: string) => {
};
return (
group.name.toLowerCase().includes(search) ||
group.description.toLowerCase().includes(search) ||
group.description?.toLowerCase().includes(search) ||
users.names?.some(name => name.includes(search)) ||
users.usernames?.some(username => username.includes(search)) ||
users.emails?.some(email => email.includes(search))
Expand Down
78 changes: 57 additions & 21 deletions frontend/src/component/common/RoleDescription/RoleDescription.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { SxProps, Theme, styled } from '@mui/material';
import { SupervisedUserCircle } from '@mui/icons-material';
import { ConditionallyRender } from '../ConditionallyRender/ConditionallyRender';
import { useRole } from 'hooks/api/getters/useRole/useRole';
import {
Expand All @@ -24,20 +25,45 @@ const StyledDescription = styled('div', {
borderRadius: tooltip ? 0 : theme.shape.borderRadiusMedium,
}));

const StyledDescriptionBlock = styled('div')(({ theme }) => ({
const StyledPermissionsLabel = styled('p')(({ theme }) => ({
color: theme.palette.text.primary,
marginTop: theme.spacing(2),
marginBottom: theme.spacing(0.5),
}));

const StyledDescriptionHeader = styled('p')(({ theme }) => ({
const StyledPermissions = styled('div')(({ theme }) => ({
display: 'flex',
flexDirection: 'column',
gap: theme.spacing(1),
}));

const StyledRoleHeader = styled('p')(({ theme }) => ({
display: 'flex',
alignItems: 'center',
gap: theme.spacing(0.5),
color: theme.palette.text.primary,
fontSize: theme.fontSizes.smallBody,
fontSize: theme.fontSizes.bodySize,
fontWeight: theme.fontWeight.bold,
}));

const StyledSupervisedUserCircle = styled(SupervisedUserCircle)(
({ theme }) => ({
fontSize: theme.fontSizes.mainHeader,
})
);

const StyledDescriptionHeader = styled('p')(({ theme }) => ({
color: theme.palette.text.secondary,
fontWeight: theme.fontWeight.bold,
marginBottom: theme.spacing(1),
}));

const StyledDescriptionSubHeader = styled('p')(({ theme }) => ({
fontSize: theme.fontSizes.smallBody,
marginTop: theme.spacing(1),
marginTop: theme.spacing(0.5),
}));

const StyledPermissionsList = styled('ul')(({ theme }) => ({
margin: 0,
paddingLeft: theme.spacing(2),
}));

interface IRoleDescriptionProps {
Expand Down Expand Up @@ -66,28 +92,38 @@ export const RoleDescription = ({

return (
<StyledDescription tooltip={tooltip} {...rest}>
<StyledDescriptionHeader sx={{ mb: 0 }}>
<StyledRoleHeader>
<StyledSupervisedUserCircle color="disabled" />
{name}
</StyledDescriptionHeader>
</StyledRoleHeader>
<StyledDescriptionSubHeader>
{description}
</StyledDescriptionSubHeader>
<ConditionallyRender
condition={!PREDEFINED_ROLE_TYPES.includes(role.type)}
show={() =>
categories.map(({ label, permissions }) => (
<StyledDescriptionBlock key={label}>
<StyledDescriptionHeader>
{label}
</StyledDescriptionHeader>
{permissions.map(permission => (
<p key={permission.id}>
{permission.displayName}
</p>
show={() => (
<>
<StyledPermissionsLabel>
Role permissions:
</StyledPermissionsLabel>
<StyledPermissions>
{categories.map(({ label, permissions }) => (
<div key={label}>
<StyledDescriptionHeader>
{label}
</StyledDescriptionHeader>
<StyledPermissionsList>
{permissions.map(permission => (
<li key={permission.id}>
{permission.displayName}
</li>
))}
</StyledPermissionsList>
</div>
))}
</StyledDescriptionBlock>
))
}
</StyledPermissions>
</>
)}
/>
</StyledDescription>
);
Expand Down
30 changes: 17 additions & 13 deletions frontend/src/component/project/ProjectAccess/ProjectAccessTable/ProjectAccessTable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,11 @@ export const ProjectAccessTable: VFC = () => {
const [groupOpen, setGroupOpen] = useState(false);
const [selectedRow, setSelectedRow] = useState<IProjectAccess>();

const roleText = (roles: number[]): string =>
roles.length > 1
? `${roles.length} roles`
: access?.roles.find(({ id }) => id === roles[0])?.name || '';

const columns = useMemo(
() => [
{
Expand Down Expand Up @@ -150,14 +155,7 @@ export const ProjectAccessTable: VFC = () => {
{
id: 'role',
Header: 'Role',
accessor: (row: IProjectAccess) =>
row.entity.roles
? row.entity.roles.length > 1
? `${row.entity.roles.length} roles`
: access?.roles.find(
({ id }) => id === row.entity.roleId
)?.name
: 'No Roles!',
accessor: (row: IProjectAccess) => roleText(row.entity.roles),
Cell: ({
value,
row: { original: row },
Expand Down Expand Up @@ -490,11 +488,17 @@ export const ProjectAccessTable: VFC = () => {
setOpen={setGroupOpen}
group={selectedRow?.entity as IGroup}
projectId={projectId}
subtitle={`Role: ${
access?.roles.find(
({ id }) => id === selectedRow?.entity.roleId
)?.name
}`}
subtitle={
<>
{selectedRow && selectedRow.entity.roles.length > 1
? 'Roles:'
: 'Role:'}
Comment on lines +493 to +495
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will there always be >= 1 roles? Or could selectedRow.entity.roles.length be 0 and should it then say "Roles:" if there are 0 roles in selectedRow.entity.roles ?

Copy link
Member Author

@nunogois nunogois Sep 8, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is safe. This is shown inside project access and only when you click in a group that has access, which means the group should have a role. Worst case scenario it would display "Role: ", which doesn't sound super bad.

<RoleCell
value={roleText(selectedRow?.entity.roles || [])}
roles={selectedRow?.entity.roles || []}
/>
</>
}
onEdit={() => {
navigate(`edit/group/${selectedRow?.entity.id}`);
}}
Expand Down
4 changes: 3 additions & 1 deletion frontend/src/component/project/ProjectAccess/ProjectGroupView/ProjectGroupView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ const StyledTitle = styled('div')(({ theme }) => ({
display: 'flex',
flexDirection: 'column',
'& > span': {
display: 'flex',
alignItems: 'center',
color: theme.palette.text.secondary,
fontSize: theme.fontSizes.bodySize,
},
Expand Down Expand Up @@ -113,7 +115,7 @@ interface IProjectGroupViewProps {
setOpen: React.Dispatch<React.SetStateAction<boolean>>;
group: IGroup;
projectId: string;
subtitle: string;
subtitle: React.ReactNode;
onEdit: () => void;
onRemove: () => void;
}
Expand Down
Loading