Package Exports

nl2br-pipe

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nl2br-pipe) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

nl2br-pipe

Description
Installation
Usage
Methods
Git repository
Version

1. Description

nl2br-pipe or Nl2BrPipe is a pipe for angular2 projects which replaces the new line characters \n in a string with the   tag.

2. Installation

Install the module into your application and save it as a dev dependency in your package.json file

npm install nl2br-pipe --save-dev

3. Usage

In order to use the Nl2BrPipe you have to include/import it into your application:

import {Nl2BrPipe} from "nl2br-pipe";

Include it in your components declarations list in your @NgModule(...):

@NgModule({
  //...
  declarations: [Nl2BrPipe],
  //...
})

Use it in your template to replace new line characters \n with the   tag:

<div [innerHTML]="'<strong>test html content</strong>\nnew line\nthird line' | nl2br"></div>

Output:

<div>
  <strong>test html content</strong><br />new line<br />third line
</div>

4. Methods

transform(value: string): string

Replace the new line characters \n in a string with the   tag Bypass security and trust the given value to be safe HTML. The sanitizer will leave safe HTML intact and will replace new line character \n with the   tag.
WARNING: calling this method with untrusted user data exposes your application to XSS security risks!

Parameters:
value - string where to replace \n with   and not to escape the HTML tags.

Return:
Method returns the new string containing   tag instead of \n.

5. Git repository

https://github.com/tvicpe/nl2br-pipe

6. Version

0.0.4