/** * Copyright IBM Corp. 2023, 2025 * * This source code is licensed under the Apache-2.0 license found in the * LICENSE file in the root directory of this source tree. */ import React, { ReactNode } from 'react'; export interface GuidebannerProps { /** * Provide the contents of the Guidebanner. * One or more GuidebannerElement components are required. */ children: ReactNode; /** * Provide an optional class to be applied to the containing node. */ className?: string; /** * Tooltip text and aria label for the Close button icon. */ closeIconDescription?: string; /** * Text label for the Collapse button. */ collapseButtonLabel?: string; /** * When true, the Guidebanner will initialize in a collapsed state, * showing the title and the Expand button. * * When expanded, it will show the GuidebannerElement child components and the Collapse button. */ collapsible?: boolean; /** * Text label for the Expand button. */ expandButtonLabel?: string; /** * Tooltip text and aria label for the Next button icon. */ nextIconDescription?: string; /** * If defined, a Close button will render in the top-right corner and a * callback function will be triggered when button is clicked. */ onClose?: () => void; /** * Tooltip text and aria label for the Back button icon. */ previousIconDescription?: string; /** * Title text. */ title: string; /** * If true, insert 1 rem of "space" on the left of the component. * This will allow the component's content to line up with other * content on the page under special circumstances. */ withLeftGutter?: boolean; /** * A handler for managing the controlled state of open prop. If not passed the open prop will not be honored and an uncontrolled state will be used. */ onChange?: (value: boolean) => void; /** * For controlled usage of the tile open state. This prop only works when an onChange prop is also passed, otherwise an uncontrolled state is used. */ open?: boolean; } /** * The guide banner sits at the top of a page, or page-level tab, * to introduce foundational concepts related to the page's content. */ export declare const Guidebanner: React.ForwardRefExoticComponent>; //# sourceMappingURL=Guidebanner.d.ts.map