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

web: Enhance accordion header interactions for better UX #12813

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

web: Enhance accordion header interactions for better UX #12813

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
5 changes: 5 additions & 0 deletions web/src/common/styles/authentik.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,11 @@ html > form > input {
margin-bottom: 6px;
}

.pf-m-pressable {
cursor: pointer;
user-select: none;
}

/* Flow-card adjustments for static pages */
.pf-c-brand {
padding-top: calc(
Expand Down
67 changes: 57 additions & 10 deletions web/src/elements/forms/FormGroup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { AKElement } from "@goauthentik/elements/Base";
import { msg } from "@lit/localize";
import { CSSResult, TemplateResult, css, html } from "lit";
import { customElement, property } from "lit/decorators.js";
import { createRef, ref } from "lit/directives/ref.js";

import PFButton from "@patternfly/patternfly/components/Button/button.css";
import PFForm from "@patternfly/patternfly/components/Form/form.css";
Expand All @@ -14,13 +15,9 @@ import PFBase from "@patternfly/patternfly/patternfly-base.css";
*
* Mostly visual effects, with a single interaction for opening/closing the view.
*
*/

/**
* TODO: Listen for custom events from its children about 'invalidation' events, and
* @todo Listen for custom events from its children about 'invalidation' events, and
* trigger the `expanded` property as needed.
*/

@customElement("ak-form-group")
export class FormGroup extends AKElement {
@property({ type: Boolean, reflect: true })
Expand All @@ -36,15 +33,62 @@ export class FormGroup extends AKElement {
PFButton,
PFFormControl,
css`
/**
* Workaround to trigger the hover effect on the button when the header is hovered.
*
* Alternatively, we group the expander button and header, but the grid would have to be
* restructured to allow for this.
*/
.pf-c-form__field-group:has(.pf-c-form__field-group-header:hover) .pf-c-button {
color: var(--pf-global--Color--100) !important;
}

/**
* Transition ensuring a smooth animation when the body is expanded/collapsed.
*/
slot[name="body"] {
transition-behavior: allow-discrete;
transition-property: opacity, display, transform;
transition-duration: var(--pf-global--TransitionDuration);
transition-timing-function: var(--pf-global--TimingFunction);
display: block;
opacity: 1;
transform: scaleY(1);
transform-origin: top left;
will-change: opacity, display, transform;
}

slot[name="body"][hidden] {
opacity: 0 !important;
display: none !important;
transform: scaleY(0) !important;
}
`,
];
}

formRef = createRef<HTMLFormElement>();

scrollAnimationFrame = -1;

scrollIntoView = (): void => {
this.formRef.value?.scrollIntoView({
behavior: "smooth",
});
};

toggleExpanded = (): void => {
cancelAnimationFrame(this.scrollAnimationFrame);

this.expanded = !this.expanded;

if (this.expanded) {
this.scrollAnimationFrame = requestAnimationFrame(this.scrollIntoView);
}
};

render(): TemplateResult {
return html` <div class="pf-c-form">
return html`<div class="pf-c-form" ${ref(this.formRef)}>
<div class="pf-c-form__field-group ${this.expanded ? "pf-m-expanded" : ""}">
<div class="pf-c-form__field-group-toggle">
<div class="pf-c-form__field-group-toggle-button">
Expand All @@ -53,17 +97,20 @@ export class FormGroup extends AKElement {
type="button"
aria-expanded="${this.expanded}"
aria-label=${this.ariaLabel}
@click=${() => {
this.expanded = !this.expanded;
}}
@click=${this.toggleExpanded}
>
<span class="pf-c-form__field-group-toggle-icon">
<i class="fas fa-angle-right" aria-hidden="true"></i>
</span>
</button>
</div>
</div>
<div class="pf-c-form__field-group-header">
<div
class="pf-c-form__field-group-header pf-m-pressable"
@click=${this.toggleExpanded}
aria-expanded=${this.expanded}
aria-role="button"
>
<div class="pf-c-form__field-group-header-main">
<div class="pf-c-form__field-group-header-title">
<div class="pf-c-form__field-group-header-title-text">
Expand Down
Loading