@porsche-design-system/components-react
Version:
Porsche Design System is a component library designed to help developers create the best experience for software or services distributed by Dr. Ing. h.c. F. Porsche AG.
51 lines (50 loc) • 2.34 kB
TypeScript
import type { BaseProps } from '../../BaseProps';
import type { SelectedAriaAttributes, DrilldownAriaAttribute, DrilldownUpdateEventDetail } from '../types';
export type PDrilldownProps = BaseProps & {
/**
* Sets which `p-drilldown-item` (by `identifier`) is currently expanded to show its sub-navigation level.
*/
activeIdentifier?: string | undefined;
/**
* Sets ARIA attributes on the drilldown dialog element for improved screen reader accessibility.
*/
aria?: SelectedAriaAttributes<DrilldownAriaAttribute>;
/**
* Emitted when the user closes the drilldown via the close button or Escape key.
*/
onDismiss?: (event: CustomEvent<void>) => void;
/**
* Emitted when the active navigation level changes, with the new `activeIdentifier` in the event detail.
*/
onUpdate?: (event: CustomEvent<DrilldownUpdateEventDetail>) => void;
/**
* Controls whether the drilldown navigation panel is visible.
* @default false
*/
open?: boolean;
};
export declare const PDrilldown: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
/**
* Sets which `p-drilldown-item` (by `identifier`) is currently expanded to show its sub-navigation level.
*/
activeIdentifier?: string | undefined;
/**
* Sets ARIA attributes on the drilldown dialog element for improved screen reader accessibility.
*/
aria?: SelectedAriaAttributes<DrilldownAriaAttribute>;
/**
* Emitted when the user closes the drilldown via the close button or Escape key.
*/
onDismiss?: (event: CustomEvent<void>) => void;
/**
* Emitted when the active navigation level changes, with the new `activeIdentifier` in the event detail.
*/
onUpdate?: (event: CustomEvent<DrilldownUpdateEventDetail>) => void;
/**
* Controls whether the drilldown navigation panel is visible.
* @default false
*/
open?: boolean;
} & {
children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLElement>>;