@theredhead — Frontend Library - v1.0.0
    Preparing search index...

    Class UIDashboardPanel

    A single panel inside a UIDashboard.

    The panel renders a header bar (title + optional collapse / remove controls) and projects arbitrary content via <ng-content>.

    <ui-dashboard-panel [config]="{ id: 'sales', title: 'Sales KPI', collapsible: true }">
      <p>Revenue chart goes here</p>
    </ui-dashboard-panel>
    Index

    Constructors

    constructor

    Properties

    collapsed collapsedChange collapseIcon config gridColumn gridRow isCollapsible isRemovable notified panelRemoved removed removeIcon

    Methods

    clearNotification notify remove restore toggleCollapse

    Constructors

    Properties

    collapsed: WritableSignal<boolean> = ...

    Whether the panel body is currently collapsed.

    collapsedChange: OutputEmitterRef<boolean> = ...

    Emitted when the collapsed state changes.

    collapseIcon: Signal<
        "<path d=\"m6 9 6 6 6-6\" />"
        | "<path d=\"m9 18 6-6-6-6\" />",
    > = ...

    SVG icon for the collapse toggle button.

    config: InputSignal<DashboardPanelConfig> = ...

    Panel configuration (id, title, grid placement, flags).

    gridColumn: Signal<string | undefined> = ...

    CSS grid-column value derived from placement config.

    gridRow: Signal<string | undefined> = ...

    CSS grid-row value derived from placement config.

    isCollapsible: Signal<boolean> = ...

    Whether the panel header shows a collapse toggle.

    isRemovable: Signal<boolean> = ...

    Whether the panel header shows a remove button.

    notified: WritableSignal<boolean> = ...

    Whether the panel currently has an active notification.

    panelRemoved: OutputEmitterRef<string> = ...

    Emitted when the user removes (hides) this panel.

    removed: WritableSignal<boolean> = ...

    Whether the panel has been removed (hidden) by the user.

    removeIcon: "<path d=\"M18 6 6 18\" /><path d=\"m6 6 12 12\" />" = UIIcons.Lucide.Math.X

    SVG icon for the remove button.

    Methods

    • Clear the active notification.

      Returns void

    • Activate a notification on this panel.

      The notification accent remains visible until the panel is focused (expanded) or the optional timeoutMs elapses.

      Parameters

      • timeoutMs: number = 0

        Auto-clear delay in milliseconds. When 0 or omitted the notification persists until manually cleared.

      Returns void

    • Remove (hide) the panel.

      Returns void

    • Restore a previously removed panel.

      Returns void

    • Toggle the collapsed state.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods