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

Context Help Panel in 'Stage users' #610

Merged
merged 1 commit into from
Jan 13, 2025
Merged

Context Help Panel in 'Stage users' #610

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
14 changes: 14 additions & 0 deletions src/assets/documentation/documentation-links.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,19 @@
"name": "Managing user accounts",
"url": "https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/managing_idm_users_groups_hosts_and_access_control_rules/managing-user-accounts-using-the-idm-web-ui_managing-users-groups-hosts"
}
],
"stage-users": [
{
"name": "Adding new users",
"url": "https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/managing_idm_users_groups_hosts_and_access_control_rules/managing-user-accounts-using-the-idm-web-ui_managing-users-groups-hosts#adding-users-in-the-web-ui_managing-user-accounts-using-the-idm-web-ui"
},
{
"name": "Activating stage users",
"url": "https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/managing_idm_users_groups_hosts_and_access_control_rules/managing-user-accounts-using-the-idm-web-ui_managing-users-groups-hosts#activating-stage-users-in-the-idm-web-ui_managing-user-accounts-using-the-idm-web-ui"
},
{
"name": "Deleting users",
"url": "https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/managing_idm_users_groups_hosts_and_access_control_rules/managing-user-accounts-using-the-idm-web-ui_managing-users-groups-hosts#deleting-users-in-the-idm-web-ui_managing-user-accounts-using-the-idm-web-ui"
}
]
}
162 changes: 93 additions & 69 deletions src/pages/StageUsers/StageUsers.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import UsersTable from "../../components/tables/UsersTable";
// Components
import PaginationLayout from "src/components/layouts/PaginationLayout";
import BulkSelectorPrep from "src/components/BulkSelectorPrep";
import ContextualHelpPanel from "src/components/ContextualHelpPanel/ContextualHelpPanel";
// Modals
import DeleteUsers from "src/components/modals/UserModals/DeleteUsers";
import AddUser from "src/components/modals/UserModals/AddUser";
Expand Down Expand Up @@ -419,6 +420,18 @@ const StageUsers = () => {
submitSearchValue,
};

// Contextual links panel
const [isContextualPanelExpanded, setIsContextualPanelExpanded] =
React.useState(false);

const onOpenContextualPanel = () => {
setIsContextualPanelExpanded(!isContextualPanelExpanded);
};

const onCloseContextualPanel = () => {
setIsContextualPanelExpanded(false);
};

// List of Toolbar items
const toolbarItems: ToolbarItem[] = [
{
Expand Down Expand Up @@ -501,7 +514,12 @@ const StageUsers = () => {
},
{
key: 8,
element: <HelpTextWithIconLayout textContent="Help" />,
element: (
<HelpTextWithIconLayout
textContent="Help"
onClick={onOpenContextualPanel}
/>
),
},
{
key: 9,
Expand All @@ -519,77 +537,83 @@ const StageUsers = () => {

// Render 'Stage users'
return (
<Page>
<alerts.ManagedAlerts />
<PageSection variant={PageSectionVariants.light}>
<TitleLayout
id="stage users title"
headingLevel="h1"
text="Stage users"
<ContextualHelpPanel
fromPage="stage-users"
isExpanded={isContextualPanelExpanded}
onClose={onCloseContextualPanel}
>
<Page>
<alerts.ManagedAlerts />
<PageSection variant={PageSectionVariants.light}>
<TitleLayout
id="stage users title"
headingLevel="h1"
text="Stage users"
/>
</PageSection>
<PageSection
variant={PageSectionVariants.light}
isFilled={false}
className="pf-v5-u-m-lg pf-v5-u-pb-md pf-v5-u-pl-0 pf-v5-u-pr-0"
>
<ToolbarLayout
className="pf-v5-u-pt-0 pf-v5-u-pl-lg pf-v5-u-pr-md"
contentClassName="pf-v5-u-p-0"
toolbarItems={toolbarItems}
/>
<div style={{ height: `calc(100vh - 352.2px)` }}>
<OuterScrollContainer>
<InnerScrollContainer>
{batchError !== undefined && batchError ? (
<GlobalErrors errors={globalErrors.getAll()} />
) : (
<UsersTable
shownElementsList={stageUsersList}
from="stage-users"
showTableRows={showTableRows}
usersData={usersTableData}
buttonsData={usersTableButtonsData}
paginationData={selectedPerPageData}
searchValue={searchValue}
/>
)}
</InnerScrollContainer>
</OuterScrollContainer>
</div>
<PaginationLayout
list={stageUsersList}
paginationData={paginationData}
variant={PaginationVariant.bottom}
widgetId="pagination-options-menu-bottom"
className="pf-v5-u-pb-0 pf-v5-u-pr-md"
/>
</PageSection>
<ModalErrors errors={modalErrors.getAll()} />
<AddUser
show={showAddModal}
from="stage-users"
setShowTableRows={setShowTableRows}
handleModalToggle={onAddModalToggle}
onOpenAddModal={onAddClickHandler}
onCloseAddModal={onCloseAddModal}
onRefresh={refreshUsersData}
/>
</PageSection>
<PageSection
variant={PageSectionVariants.light}
isFilled={false}
className="pf-v5-u-m-lg pf-v5-u-pb-md pf-v5-u-pl-0 pf-v5-u-pr-0"
>
<ToolbarLayout
className="pf-v5-u-pt-0 pf-v5-u-pl-lg pf-v5-u-pr-md"
contentClassName="pf-v5-u-p-0"
toolbarItems={toolbarItems}
<DeleteUsers
show={showDeleteModal}
from="stage-users"
handleModalToggle={onDeleteModalToggle}
selectedUsersData={selectedUsersData}
buttonsData={deleteUsersButtonsData}
onRefresh={refreshUsersData}
/>
<div style={{ height: `calc(100vh - 352.2px)` }}>
<OuterScrollContainer>
<InnerScrollContainer>
{batchError !== undefined && batchError ? (
<GlobalErrors errors={globalErrors.getAll()} />
) : (
<UsersTable
shownElementsList={stageUsersList}
from="stage-users"
showTableRows={showTableRows}
usersData={usersTableData}
buttonsData={usersTableButtonsData}
paginationData={selectedPerPageData}
searchValue={searchValue}
/>
)}
</InnerScrollContainer>
</OuterScrollContainer>
</div>
<PaginationLayout
list={stageUsersList}
paginationData={paginationData}
variant={PaginationVariant.bottom}
widgetId="pagination-options-menu-bottom"
className="pf-v5-u-pb-0 pf-v5-u-pr-md"
<ActivateStageUsers
show={showActivateModal}
handleModalToggle={onActivateModalToggle}
selectedUsers={selectedUsers}
onSuccess={refreshUsersData}
/>
</PageSection>
<ModalErrors errors={modalErrors.getAll()} />
<AddUser
show={showAddModal}
from="stage-users"
setShowTableRows={setShowTableRows}
handleModalToggle={onAddModalToggle}
onOpenAddModal={onAddClickHandler}
onCloseAddModal={onCloseAddModal}
onRefresh={refreshUsersData}
/>
<DeleteUsers
show={showDeleteModal}
from="stage-users"
handleModalToggle={onDeleteModalToggle}
selectedUsersData={selectedUsersData}
buttonsData={deleteUsersButtonsData}
onRefresh={refreshUsersData}
/>
<ActivateStageUsers
show={showActivateModal}
handleModalToggle={onActivateModalToggle}
selectedUsers={selectedUsers}
onSuccess={refreshUsersData}
/>
</Page>
</Page>
</ContextualHelpPanel>
);
};

Expand Down
14 changes: 14 additions & 0 deletions tests/features/contextual_help_panel.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,19 @@ Feature: Contextual help links panel
When I click on close button in the panel
Then I should not see contextual help panel

# Stage users page
Scenario: Open the contextual help links panel on 'stage-users' main page
Given I am on "stage-users" page
When I click on "Help" button
Then I should see contextual help panel
And I should see a title "Links" in the panel
* I should see a list of links

Scenario: Close the contextual help links panel on 'Stage users' main page
Given I am on "stage-users" page
Given I should see contextual help panel
When I click on close button in the panel
Then I should not see contextual help panel



Loading