NgDoc

What is NgDoc? Installation SSR Configuration NEW OPTIONS Migrations
Pages and categories UPDATED Blockquotes NEW STYLES Images and embeds NEW Code blocks Mermaid diagrams NEW Nunjucks Demo and Demo Pane Playground Keywords
Auto generation Documenting declarations Rendering API NEW
Page Processors Page Skeleton Layout Search Themes UPDATED Icons
Performance Ignoring file lines
API References Develop
@ng-doc/app / Class

NgDocSidebarService

Decorators:@Injectable

Service for sidebar, it can be used to hide/show sidebar or to check if sidebar is collapsable.

Constructor

No documentation has been provided.

Presentation
constructor(
	
): NgDocSidebarService;

Properties

NameTypeDescription
document
p r
Document
expanded
p r
BehaviorSubject<boolean>
router
p r
Router
scroll
p r
NgDocScrollService
window
p r
Window

Accessors

get isMobile

No documentation has been provided.

Presentation
get isMobile(): boolean;
Type

boolean

Methods

hide()

Hide sidebar, and unblock scrolling.

Presentation
hide(): void;
Returns
void

isExpanded()

Indicates if sidebar is visible, based on the show/hide methods.

Presentation
isExpanded(): Observable<boolean>;
Returns
Observable<boolean>

show()

Show sidebar, and block scrolling.

Presentation
show(): void;
Returns
void

toggle()

Toggle sidebar visibility.

Presentation
toggle(): void;
Returns
void
MIT © 2023 Aleksandr Skoropad