@talenra/components documentation
  1. Injectables
  2. SidepanelService

File

workspace-sidepanel/src/sideplanel-service/sidepanel.service.ts

Description

Provides control and state of the sidepanel used in workspace-sidepanel.

Import

Example :
import { SidepanelService } from '@talenra/components/workspace-sidepanel';

Index

Properties
Methods

Methods

Public setExpanded
setExpanded(isExpanded: boolean)

Collapses or expands the sidepanel

see WorkspaceSidepanelComponent

Parameters :
Name Type Optional
isExpanded boolean No
Returns : void
Public setHidden
setHidden(isHidden: boolean)

Hide or show the sidepanel

see WorkspaceSidepanelComponent

Parameters :
Name Type Optional
isHidden boolean No
Returns : void
Public setSelectedItem
setSelectedItem(key: null | string)

Updates the current sidepanel item.

Parameters :
Name Type Optional
key null | string No
Returns : void

Properties

Public Readonly isExpanded$
Type : unknown
Default value : new BehaviorSubject(false)

Provides whether the sidepanel is expanded. Note that the state (collapsed or expanded) is kept even if the current layout does not involve a sidepanel.

Used by
Public Readonly isHidden$
Type : unknown
Default value : new BehaviorSubject(false)

Provides whether the sidepanel is hidden. Note that the state (hidden or visible) is kept even if the current layout does not involve a sidepanel.

Used by
Public Readonly selectedItem$
Type : unknown
Default value : new BehaviorSubject<null | string>(null)

Provides the sidepanel's state (current item).

Used by

results matching ""

    No results matching ""