@colsen1991/ngx-translate-extract-marker/README.md

Function, pipe and directive to manually mark strings to be extracted using ngx-translate-extract

# ngx-translate-extract-marker
This is a fork of a great library by [Kim Biesbjerg](https://github.com/biesbjerg), but as far as I can tell the original library is unfortunately no longer being developed

## Installation
`$ npm install @colsen1991/ngx-translate-extract-marker`

### Important notice
The marker pipe and directive is not supported in Kim's ngx-translate-extract package.
Please use [Vendure's](https://github.com/vendure-ecommerce/ngx-translate-extract) instead: `$ npm install @colsen1991/ngx-translate-extract`.


## Mark strings for extraction using the marker function
If, for some reason, you want to extract strings not passed directly to `ngx-translate/TranslateService`'s `get()`, `instant()` or `stream()` methods, you can wrap them in a custom marker function to let `ngx-translate-extract` know you want to extract them.

Import and use the marker function:

```ts
import { marker } from '@colsen1991/ngx-translate-extract-marker';

marker('Extract me');
```

Or you can alias the `marker()` method:

```ts
import { marker as _ } from '@colsen1991/ngx-translate-extract-marker';

_('Extract me');
```

Then run the extract script: `$ ngx-translate-extract`

## Mark strings for extraction using the marker pipe
If, for some reason, you want to extract strings not passed directly to `ngx-translate/TranslatePipe`, you can pass them into a custom marker pipe to let `ngx-translate-extract` know you want to extract them.

Import and use the marker pipe in your `@NgModule`:

```ts
import { MarkerPipe } from '@colsen1991/ngx-translate-extract-marker/extras';

@NgModule({ declarations: [MarkerPipe] })
export class YourModule {}
```

Or use the standalone pipe in your standalone component (**careful not to use both methods**):

```ts
import { MarkerPipeStandalone } from '@colsen1991/ngx-translate-extract-marker/extras';

@Component({ imports: [MarkerPipeStandalone], standalone: true })
export class StandaloneComponent {}
```

Then mark strings in your templates:

```angular2html
<your-component [yourInput]="'Hello world' | marker"></your-component>
```

## Mark strings for extraction using the marker directive
If, for some reason, you want to extract strings not passed directly to `ngx-translate/TranslateDirective`, you can wrap them in a custom marker directive to let `ngx-translate-extract` know you want to extract them.

Import and use the marker directive in your `@NgModule`:

```ts
import { MarkerDirective } from '@colsen1991/ngx-translate-extract-marker/extras';

@NgModule({ declarations: [MarkerDirective] })
export class YourModule {}
```

Or use the standalone directive in your standalone component (**careful not to use both methods**):

```ts
import { MarkerDirectiveStandalone } from '@colsen1991/ngx-translate-extract-marker/extras';

@NgModule({ imports: [MarkerDirectiveStandalone], standalone: true })
export class StandaloneComponent {}
```
Then mark strings in your templates:

```angular2html
<p marker>Hello World</p>
```

Then run the extract script: `$ ngx-translate-extract`

## ngx-translate-extract-marker module
You may also import the marker pipe and directive as a module:

```ts
import { MarkerModule } from '@colsen1991/ngx-translate-extract-marker/extras';

@NgModule({ imports: [MarkerModule] })
export class YourModule {}
```

## ngx-translate-extract
See [ngx-translate-extract](https://github.com/vendure-ecommerce/ngx-translate-extract) and [ngx-translate](https://github.com/ngx-translate/core) for more details.

## Credits
Original library, idea and code: [@biesbjerg/ngx-translate-extract-marker](https://github.com/biesbjerg/ngx-translate-extract-marker) ❤️