@skyux/layout/lib/modules/box/box.component.d.ts

This library was generated with [Nx](https://nx.dev).

import { ElementRef, TemplateRef } from '@angular/core';
import { SkyBoxControlsComponent } from './box-controls.component';
import { SkyBoxHeadingLevel } from './box-heading-level';
import { SkyBoxHeadingStyle } from './box-heading-style';
import * as i0 from "@angular/core";
/**
 * Provides a common look-and-feel for box content with options to display a common box header, specify body content, and display common box controls.
 */
export declare class SkyBoxComponent {
    #private;
    /**
     * The text to display as the box's heading.
     */
    set headingText(value: string | undefined);
    get headingText(): string | undefined;
    /**
     * Indicates whether to hide the `headingText`.
     */
    headingHidden: boolean;
    /**
     * The semantic heading level in the document structure. The default is 2.
     * @default 2
     */
    headingLevel: SkyBoxHeadingLevel;
    /**
     * The heading [font style](https://developer.blackbaud.com/skyux/design/styles/typography#headings).
     * @default 2
     */
    set headingStyle(value: SkyBoxHeadingStyle);
    /**
     * The content of the help popover. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
     * button is added to the box heading. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
     * when clicked using the specified content and optional title. This property only applies when `headingText` is also specified.
     */
    helpPopoverContent: string | TemplateRef<unknown> | undefined;
    /**
     * The title of the help popover. This property only applies when `helpPopoverContent` is
     * also specified.
     */
    helpPopoverTitle: string | undefined;
    /**
     * A help key that identifies the global help content to display. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
     * button is placed beside the box heading. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
     * as configured by the application. This property only applies when `headingText` is also specified.
     */
    helpKey: string | undefined;
    /**
     * The ARIA label for the box. This sets the box's `aria-label` attribute to provide a text equivalent for screen readers
     * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
     * If the box includes a visible label, use `ariaLabelledBy` instead.
     * For more information about the `aria-label` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-label).
     * @deprecated Use `headingText` instead.
     */
    ariaLabel: string | undefined;
    /**
     * The HTML element ID of the element that labels
     * the box. This sets the box's `aria-labelledby` attribute to provide a text equivalent for screen readers
     * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
     * If the box does not include a visible label, use `ariaLabel` instead.
     * For more information about the `aria-labelledby` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-labelledby).
     * @deprecated Use `headingText` instead.
     */
    ariaLabelledBy: string | undefined;
    /**
     * The ARIA role for the box
     * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)
     * by indicating what the box contains. For information about
     * how an ARIA role indicates what an item represents on a web page,
     * see the [WAI-ARIA roles model](https://www.w3.org/WAI/PF/aria/#roles).
     */
    ariaRole: string | undefined;
    set boxHeaderRef(value: ElementRef | undefined);
    set boxControls(value: SkyBoxControlsComponent | undefined);
    headerId: string;
    protected headingClass: string;
    static ɵfac: i0.ɵɵFactoryDeclaration<SkyBoxComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<SkyBoxComponent, "sky-box", never, { "headingText": { "alias": "headingText"; "required": false; }; "headingHidden": { "alias": "headingHidden"; "required": false; }; "headingLevel": { "alias": "headingLevel"; "required": false; }; "headingStyle": { "alias": "headingStyle"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "ariaRole": { "alias": "ariaRole"; "required": false; }; }, {}, ["boxHeaderRef", "boxControls"], ["sky-box-header", "sky-box-controls", "*"], false, never>;
    static ngAcceptInputType_headingHidden: unknown;
    static ngAcceptInputType_headingLevel: unknown;
    static ngAcceptInputType_headingStyle: unknown;
}