NgDoc

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

playgroundAction

Renders playground point on the page, it will be rendered by the application

Presentation

function playgroundAction(
  pId: string,
  options?: NgDocPlaygroundOptions | undefined,
): NgDocAction<string>;

Returns

NgDocAction<string>

Parameters

NameTypeDescription
pId
string

Playground id in the config

options
NgDocPlaygroundOptions | undefined

Options for configuring the action

  • Presentation
  • Returns
  • Parameters
MIT © 2023 Aleksandr Skoropad