@patternfly/elements
Version:
PatternFly Elements
71 lines (70 loc) • 3.51 kB
TypeScript
import { LitElement, type TemplateResult } from 'lit';
import '@patternfly/elements/pf-icon/pf-icon.js';
/**
* **Jump links** allow users to navigate to sections within a page.
* @fires toggle - when the `expanded` disclosure widget is toggled
* @slot - Place pf-jump-links-items here
* @cssprop --pf-c-jump-links__list--Display
* @cssprop --pf-c-jump-links__list--FlexDirection
* @cssprop --pf-c-jump-links__list--PaddingTop -- padding around the list of links
* @cssprop --pf-c-jump-links__list--PaddingRight
* @cssprop --pf-c-jump-links__list--PaddingBottom
* @cssprop --pf-c-jump-links__list--PaddingLeft
* @cssprop --pf-c-jump-links__list--Visibility
* @cssprop --pf-c-jump-links__list--before--BorderColor
* @cssprop --pf-c-jump-links__list--before--BorderTopWidth
* @cssprop --pf-c-jump-links__list--before--BorderRightWidth
* @cssprop --pf-c-jump-links__list--before--BorderBottomWidth
* @cssprop --pf-c-jump-links__list--before--BorderLeftWidth
* @cssprop --pf-c-jump-links__toggle--MarginBottom--base
* @cssprop --pf-c-jump-links__toggle--MarginTop -- padding around the expandable jump links disclosure widget.
* @cssprop --pf-c-jump-links__toggle--MarginBottom
* @cssprop --pf-c-jump-links__toggle--MarginBottom--base
* @cssprop --pf-c-jump-links__toggle--MarginLeft
* @cssprop --pf-c-jump-links__toggle-text--Color
* @cssprop --pf-c-button--PaddingTop -- padding around the expandable jump links disclosure widget.
* @cssprop --pf-c-button--PaddingRight
* @cssprop --pf-c-button--PaddingBottom
* @cssprop --pf-c-button--PaddingLeft
* @cssprop --pf-c-jump-links__toggle-icon--Rotate
* @cssprop --pf-c-jump-links__toggle-icon--Transition
* @cssprop --pf-c-jump-links__toggle-text--MarginLeft
* @cssprop --pf-c-jump-links--m-expanded__toggle--MarginBottom
* @cssprop --pf-c-jump-links--m-expanded__toggle-icon--Rotate
* @cssprop --pf-c-jump-links--m-expanded__toggle-icon--Color
* @cssprop --pf-c-jump-links--m-vertical__list--PaddingTop
* @cssprop --pf-c-jump-links--m-vertical__list--PaddingRight
* @cssprop --pf-c-jump-links--m-vertical__list--PaddingBottom
* @cssprop --pf-c-jump-links--m-vertical__list--PaddingLeft
* @cssprop --pf-c-jump-links--m-vertical__list--before--BorderTopWidth
* @cssprop --pf-c-jump-links--m-vertical__list--before--BorderLeftWidth
* @cssprop --pf-c-jump-links--m-vertical__item--m-current__link--before--BorderTopWidth
* @cssprop --pf-c-jump-links--m-vertical__item--m-current__link--before--BorderLeftWidth
* @cssprop --pf-c-jump-links--m-vertical__list--FlexDirection
*/
export declare class PfJumpLinks extends LitElement {
#private;
static readonly styles: CSSStyleSheet[];
/** Whether the element features a disclosure widget around the nav items */
expandable: boolean;
/** Whether the expandable element's disclosure widget is expanded */
expanded: boolean;
/** Whether the layout of children is vertical or horizontal. */
vertical: boolean;
/** Whether to center children. */
centered: boolean;
/** Offset to add to the scroll position, potentially for a masthead which content scrolls under. */
offset: number;
/** Label to add to nav element. */
label?: string;
protected getUpdateComplete(): Promise<boolean>;
connectedCallback(): void;
firstUpdated(): void;
updated(changed: Map<string, unknown>): void;
render(): TemplateResult<1>;
}
declare global {
interface HTMLElementTagNameMap {
'pf-jump-links': PfJumpLinks;
}
}