@code-name-jack/ngx-linkifyjs 20.0.1 → 20.1.0

package/README.md

@@ -1,24 +1,587 @@
-# NgxLinkifyjs
+# ngx-linkifyjs
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 14.
+[![npm version](https://badge.fury.io/js/ngx-linkifyjs.svg)](https://badge.fury.io/js/ngx-linkifyjs)
+[![license](https://img.shields.io/github/license/anthonynahas/ngx-linkifyjs.svg?style=flat-square)](https://github.com/AnthonyNahas/ngx-linkifyjs/blob/master/LICENSE)
 
-## Code scaffolding
+> **Angular 20+ wrapper for linkifyjs** - Automatically find and convert URLs, emails, hashtags, and mentions in text to HTML links.
 
-Run `ng generate component component-name --project ngx-linkifyjs-v2` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project ngx-linkifyjs-v2`.
-> Note: Don't forget to add `--project ngx-linkifyjs-v2` or else it will be added to the default project in your `angular.json` file. 
+<p align="center">
+  <img alt="ngx-linkifyjs demo" width="320px" style="text-align: center;" 
+  src="https://cdn.jsdelivr.net/gh/anthonynahas/ngx-linkifyjs@master/assets/demo.gif">
+</p>
 
-## Build
+## ✨ Features
 
-Run `ng build ngx-linkifyjs-v2` to build the project. The build artifacts will be stored in the `dist/` directory.
+- 🔗 **Auto-detect URLs** - Finds and linkifies URLs (with or without protocol)
+- 📧 **Email addresses** - Converts emails to `mailto:` links
+- #️⃣ **Hashtags** - Linkify hashtags for social media content
+- @ **Mentions** - Convert @mentions to links
+- 🎨 **Customizable** - Full control over link styling and behavior
+- 🚀 **Angular 20+** - Built for modern Angular with standalone-first architecture
+- 📦 **Tree-shakeable** - Optimized bundle size
+- 🔧 **TypeScript** - Full type safety
 
-## Publishing
+## 🎮 Live Demo
 
-After building your library with `ng build ngx-linkifyjs-v2`, go to the dist folder `cd dist/ngx-linkifyjs-v2` and run `npm publish --access=public`.
+A comprehensive demo application is available in the [repository](https://github.com/code-name-jack/ngx-linkifyjs-v2) showcasing:
+- 🎨 Interactive examples with live editing
+- 🔧 Service API demonstrations  
+- ⚙️ Configuration options showcase
+- 📝 Copy-paste code examples
 
-## Running unit tests
+---
 
-Run `ng test ngx-linkifyjs-v2` to execute the unit tests via [Karma](https://karma-runner.github.io).
+## 📦 Installation
 
-## Further help
+### Option 1: Using Angular Schematics (Recommended)
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
+```bash
+ng add @code-name-jack/ngx-linkifyjs
+```
+
+### Option 2: Using npm
+
+```bash
+npm install @code-name-jack/ngx-linkifyjs
+```
+
+---
+
+## 🚀 Quick Start
+
+**1. Configure in your app (app.config.ts):**
+
+```typescript
+import { ApplicationConfig } from '@angular/core';
+import { provideNgxLinkifyjs } from '@code-name-jack/ngx-linkifyjs';
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideNgxLinkifyjs({
+      enableHash: true,     // Enable hashtag detection
+      enableMention: true   // Enable @mention detection
+    })
+  ]
+};
+```
+
+**2. Import the pipe in your component:**
+
+```typescript
+import { Component } from '@angular/core';
+import { NgxLinkifyjsPipe } from '@code-name-jack/ngx-linkifyjs';
+
+@Component({
+  selector: 'app-example',
+  standalone: true,
+  imports: [NgxLinkifyjsPipe],
+  template: `
+    <div [innerHTML]="text | linkify"></div>
+  `
+})
+export class ExampleComponent {
+  text = 'Visit https://github.com or email info@example.com';
+}
+```
+
+**3. Using the service:**
+
+```typescript
+import { Component, inject } from '@angular/core';
+import { NgxLinkifyjsService } from '@code-name-jack/ngx-linkifyjs';
+
+@Component({
+  selector: 'app-example',
+  standalone: true
+})
+export class ExampleComponent {
+  private linkifyService = inject(NgxLinkifyjsService);
+  
+  constructor() {
+    // Find all links
+    const links = this.linkifyService.find('Visit github.com');
+    // Output: [{ type: 'url', value: 'github.com', href: 'http://github.com' }]
+    
+    // Test if text contains links
+    const hasLinks = this.linkifyService.test('example.com'); // true
+    
+    // Convert text to HTML
+    const html = this.linkifyService.linkify('Visit example.com');
+  }
+}
+```
+
+> **Note:** Since `NgxLinkifyjsService` uses `providedIn: 'root'`, it's automatically available once you add `provideNgxLinkifyjs()` to your app config. The `provideNgxLinkifyjs()` function is only needed to configure plugin options (hashtags/mentions).
+
+---
+
+## 📖 Usage Guide
+
+### Using the Pipe
+
+The `linkify` pipe transforms text into linkified HTML:
+
+```html
+<!-- Basic usage -->
+<p [innerHTML]="'Visit https://example.com' | linkify"></p>
+
+<!-- With custom options -->
+<p [innerHTML]="text | linkify:options"></p>
+```
+
+```typescript
+import { NgxLinkifyOptions } from '@code-name-jack/ngx-linkifyjs';
+
+export class MyComponent {
+  text = 'Check out github.com and follow @angular!';
+  
+  options: NgxLinkifyOptions = {
+    className: 'custom-link',
+    target: { url: '_blank' },
+    defaultProtocol: 'https'
+  };
+}
+```
+
+### Using the Service
+
+The `NgxLinkifyjsService` provides programmatic access to linkify functionality:
+
+#### 1️⃣ `linkify(text: string, options?: NgxLinkifyOptions): string`
+
+Converts text to linkified HTML string.
+
+```typescript
+const html = this.linkifyService.linkify(
+  'Visit github.com or email support@example.com',
+  {
+    className: 'my-link',
+    target: { url: '_blank' }
+  }
+);
+// Output: 'Visit <a href="http://github.com" class="my-link" target="_blank">github.com</a> or email <a href="mailto:support@example.com" class="my-link">support@example.com</a>'
+```
+
+#### 2️⃣ `find(text: string): Link[]`
+
+Finds all links in text and returns an array of link objects.
+
+```typescript
+const links = this.linkifyService.find(
+  'Visit github.com or email test@example.com #angular'
+);
+// Output:
+// [
+//   { type: 'url', value: 'github.com', href: 'http://github.com' },
+//   { type: 'email', value: 'test@example.com', href: 'mailto:test@example.com' },
+//   { type: 'hashtag', value: '#angular', href: '#angular' }
+// ]
+```
+
+#### 3️⃣ `test(value: string | string[]): boolean`
+
+Tests if a string (or all strings in an array) contains valid links.
+
+```typescript
+this.linkifyService.test('github.com');              // true
+this.linkifyService.test('hello world');             // false
+this.linkifyService.test(['github.com', 'test.com']); // true
+this.linkifyService.test(['github.com', 'hello']);    // false
+```
+
+---
+
+## ⚙️ Configuration Options
+
+### Available Options (`NgxLinkifyOptions`)
+
+All options are optional and follow the [linkifyjs options](https://linkify.js.org/docs/options.html):
+
+```typescript
+interface NgxLinkifyOptions {
+  /**
+   * Add custom attributes to links
+   */
+  attributes?: Record<string, any>;
+  
+  /**
+   * CSS class to add to links (default: 'linkified')
+   */
+  className?: string;
+  
+  /**
+   * Default protocol for URLs without one (default: 'http')
+   */
+  defaultProtocol?: string;
+  
+  /**
+   * Event handlers for links
+   */
+  events?: Record<string, (e: Event) => void>;
+  
+  /**
+   * Format the link text
+   */
+  format?: (value: string, type: string) => string;
+  
+  /**
+   * Format the href attribute
+   */
+  formatHref?: (href: string, type: string) => string;
+  
+  /**
+   * HTML tags to ignore when linkifying
+   */
+  ignoreTags?: string[];
+  
+  /**
+   * Convert newlines to <br> tags
+   */
+  nl2br?: boolean;
+  
+  /**
+   * HTML tag to use for links (default: 'a')
+   */
+  tagName?: string;
+  
+  /**
+   * Target attribute for links
+   */
+  target?: { url: string };
+  
+  /**
+   * Validate links before linkifying
+   */
+  validate?: boolean;
+}
+```
+
+### Example: Custom Configuration
+
+```typescript
+import { NgxLinkifyOptions } from '@code-name-jack/ngx-linkifyjs';
+
+export class MyComponent {
+  options: NgxLinkifyOptions = {
+    className: 'fancy-link',
+    target: { url: '_blank' },
+    defaultProtocol: 'https',
+    
+    // Customize link text
+    format: (value, type) => {
+      if (type === 'url' && value.length > 50) {
+        return value.slice(0, 50) + '…';
+      }
+      return value;
+    },
+    
+    // Customize href
+    formatHref: (href, type) => {
+      if (type === 'hashtag') {
+        return 'https://twitter.com/hashtag/' + href.slice(1);
+      }
+      return href;
+    },
+    
+    // Add custom attributes
+    attributes: {
+      rel: 'noopener noreferrer'
+    }
+  };
+}
+```
+
+### Global Configuration
+
+Configure hashtag and mention support globally:
+
+```typescript
+// For standalone apps (in app.config.ts)
+import { ApplicationConfig } from '@angular/core';
+import { NgxLinkifyjsService, NgxLinkifyjsConfigToken } from '@code-name-jack/ngx-linkifyjs';
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    NgxLinkifyjsService,
+    {
+      provide: NgxLinkifyjsConfigToken,
+      useValue: {
+        enableHash: true,     // Enable #hashtag detection
+        enableMention: true   // Enable @mention detection
+      }
+    }
+  ]
+};
+
+// In app.config.ts
+import { provideNgxLinkifyjs } from '@code-name-jack/ngx-linkifyjs';
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideNgxLinkifyjs({
+      enableHash: false,      // Disable hashtags
+      enableMention: false    // Disable mentions
+    })
+  ]
+};
+```
+
+---
+
+## 🎨 Styling Links
+
+Add custom CSS to style your linkified links:
+
+```css
+/* Default linkified class */
+.linkified {
+  color: #0066cc;
+  text-decoration: underline;
+}
+
+.linkified:hover {
+  color: #0052a3;
+}
+
+/* Custom class from options */
+.custom-link {
+  color: #667eea;
+  font-weight: 600;
+  text-decoration: none;
+  border-bottom: 2px solid transparent;
+  transition: all 0.2s;
+}
+
+.custom-link:hover {
+  border-bottom-color: #667eea;
+}
+```
+
+---
+
+## 🔍 Link Types
+
+The library detects four types of links:
+
+| Type | Example | Output |
+|------|---------|--------|
+| **URL** | `https://example.com` | `<a href="https://example.com">...</a>` |
+| **Email** | `user@example.com` | `<a href="mailto:user@example.com">...</a>` |
+| **Hashtag** | `#angular` | `<a href="#angular">#angular</a>` |
+| **Mention** | `@username` | `<a href="/username">@username</a>` |
+
+> 💡 **Note:** Hashtags and mentions are enabled by default but can be disabled in configuration.
+
+---
+
+## 📱 Real-World Examples
+
+### Social Media Posts
+
+```typescript
+@Component({
+  template: `
+    <div class="post" [innerHTML]="post | linkify:socialOptions"></div>
+  `
+})
+export class PostComponent {
+  post = 'Check out the new @angular release! 🚀 #Angular20 https://angular.io';
+  
+  socialOptions: NgxLinkifyOptions = {
+    target: { url: '_blank' },
+    formatHref: (href, type) => {
+      if (type === 'hashtag') {
+        return `https://twitter.com/hashtag/${href.slice(1)}`;
+      }
+      if (type === 'mention') {
+        return `https://twitter.com/${href.slice(1)}`;
+      }
+      return href;
+    }
+  };
+}
+```
+
+### Comment Section
+
+```typescript
+@Component({
+  template: `
+    <div class="comment" 
+         *ngFor="let comment of comments"
+         [innerHTML]="comment.text | linkify:commentOptions">
+    </div>
+  `
+})
+export class CommentsComponent {
+  comments = [
+    { text: 'Great article! See more at example.com' },
+    { text: 'Contact me at john@example.com for details' }
+  ];
+  
+  commentOptions: NgxLinkifyOptions = {
+    className: 'comment-link',
+    target: { url: '_blank' },
+    attributes: {
+      rel: 'nofollow noopener'
+    }
+  };
+}
+```
+
+### Chat Application
+
+```typescript
+@Component({
+  selector: 'chat-message',
+  template: `
+    <div class="message" [innerHTML]="message | linkify"></div>
+  `
+})
+export class ChatMessageComponent {
+  @Input() message!: string;
+}
+```
+
+---
+
+## 🧪 Testing
+
+When testing components that use ngx-linkifyjs:
+
+```typescript
+import { ComponentFixture, TestBed } from '@angular/core/testing';
+import { NgxLinkifyjsPipe, NgxLinkifyjsService } from '@code-name-jack/ngx-linkifyjs';
+
+describe('MyComponent', () => {
+  let component: MyComponent;
+  let fixture: ComponentFixture<MyComponent>;
+
+  beforeEach(async () => {
+    await TestBed.configureTestingModule({
+      imports: [MyComponent, NgxLinkifyjsPipe],
+      providers: [NgxLinkifyjsService]
+    }).compileComponents();
+
+    fixture = TestBed.createComponent(MyComponent);
+    component = fixture.componentInstance;
+  });
+
+  it('should linkify URLs', () => {
+    component.text = 'Visit example.com';
+    fixture.detectChanges();
+    
+    const element = fixture.nativeElement;
+    expect(element.querySelector('a')).toBeTruthy();
+    expect(element.querySelector('a').href).toContain('example.com');
+  });
+});
+```
+
+---
+
+## 📚 API Reference
+
+### Exports
+
+```typescript
+// Provider function (for both standalone and NgModule apps)
+export { provideNgxLinkifyjs }
+
+// Standalone pipe
+export { NgxLinkifyjsPipe }
+
+// Service
+export { NgxLinkifyjsService }
+
+// Types & Interfaces
+export { NgxLinkifyOptions }
+export { NgxLinkifyjsConfig }
+export { Link }
+export { LinkType }
+
+// Tokens
+export { NgxLinkifyjsConfigToken }
+export { DEFAULT_CONFIG }
+```
+
+### Types
+
+```typescript
+interface Link {
+  type: string;    // 'url' | 'email' | 'hashtag' | 'mention'
+  value: string;   // Original text
+  href: string;    // Generated href attribute
+}
+
+enum LinkType {
+  URL = 'url',
+  EMAIL = 'email',
+  HASHTAG = 'hashtag',
+  MENTION = 'mention'
+}
+
+interface NgxLinkifyjsConfig {
+  enableHash?: boolean;     // Enable hashtag detection (default: true)
+  enableMention?: boolean;  // Enable mention detection (default: true)
+}
+```
+
+---
+
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+For development setup and publishing instructions, see the [Developer Guide](https://github.com/code-name-jack/ngx-linkifyjs-v2/blob/master/projects/ngx-linkifyjs-v2/README.dev.md).
+
+---
+
+## 🐛 Issues & Support
+
+- 🐛 [Report bugs](https://github.com/code-name-jack/ngx-linkifyjs-v2/issues)
+- 💡 [Request features](https://github.com/code-name-jack/ngx-linkifyjs-v2/issues)
+- 💬 [Ask questions](https://github.com/code-name-jack/ngx-linkifyjs-v2/discussions)
+
+---
+
+## 📄 License
+
+Copyright (c) 2018 Anthony Nahas  
+Copyright (c) 2022 Ethan Gerardot  
+Copyright (c) 2025 Code Name Jack
+
+Licensed under the [MIT License](LICENSE)
+
+---
+
+## 🌟 Show Your Support
+
+If this project helped you, please consider:
+
+- ⭐ Starring the repository
+- 🐛 Reporting bugs
+- 💡 Suggesting features
+- 📢 Sharing with others
+
+---
+
+## 🔗 Related Projects
+
+- [@angular-material-extensions/link-preview](https://github.com/angular-material-extensions/link-preview) - Link preview component using ngx-linkifyjs
+- [linkifyjs](https://linkify.js.org/) - The underlying linkify library
+
+---
+
+<p align="center">
+  Made with ❤️ for the Angular community
+</p>
+
+<p align="center">
+  <a href="https://www.jetbrains.com">
+    <img src="assets/jetbrains-variant-4_logos/jetbrains-variant-4.png" alt="JetBrains" height="50">
+  </a>
+  <br>
+  <sub>Supported by JetBrains with 1 ALL PRODUCTS PACK OS LICENSE</sub>
+</p>

package/fesm2022/code-name-jack-ngx-linkifyjs.mjs

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { Pipe, Injectable, InjectionToken, NgModule } from '@angular/core';
+import { Pipe, Injectable, InjectionToken, makeEnvironmentProviders } from '@angular/core';
 import linkifyStr from 'linkify-string';
 import * as linkify from 'linkifyjs';
 
@@ -13,7 +13,10 @@ var LinkType;
 
 class NgxLinkifyjsPipe {
     transform(value, options) {
-        return value ? linkifyStr(value, options) : value;
+        if (!value) {
+            return '';
+        }
+        return linkifyStr(value, options);
     }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.9", ngImport: i0, type: NgxLinkifyjsPipe, deps: [], target: i0.ɵɵFactoryTarget.Pipe }); }
     static { this.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "14.0.0", version: "20.3.9", ngImport: i0, type: NgxLinkifyjsPipe, isStandalone: true, name: "linkify" }); }
@@ -27,83 +30,119 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.9", ngImpor
         }] });
 
 class NgxLinkifyjsService {
-    constructor() {
-    }
     /**
      * Convert the passed text as a string to an appropriate url
      *
      * @param text - the string to convert
      * @param options - options to pass it to the linkifyjs library
+     * @returns HTML string with linkified URLs, emails, hashtags, and mentions
      */
     linkify(text, options) {
+        if (!text) {
+            return '';
+        }
         return linkifyStr(text, options);
     }
     /**
      * Find any links in a given text as a string
      *
      * @param text - the string to find some links
+     * @returns Array of Link objects found in the text
      */
     find(text) {
+        if (!text) {
+            return [];
+        }
         return linkify.find(text);
     }
     /**
      * Test if a given value is a link or an array of all links
      *
-     * @param value - the value to test
+     * @param value - the value to test (string or array of strings)
+     * @returns true if all values are valid links, false otherwise
      */
     test(value) {
         if (typeof value === 'string') {
             return linkify.test(value);
         }
-        return value.find(v => !linkify.test(v)) === undefined;
+        return value.every(v => linkify.test(v));
     }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.9", ngImport: i0, type: NgxLinkifyjsService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
-    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.3.9", ngImport: i0, type: NgxLinkifyjsService }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.3.9", ngImport: i0, type: NgxLinkifyjsService, providedIn: 'root' }); }
 }
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.9", ngImport: i0, type: NgxLinkifyjsService, decorators: [{
-            type: Injectable
-        }], ctorParameters: () => [] });
+            type: Injectable,
+            args: [{ providedIn: 'root' }]
+        }] });
 
+/**
+ * Injection token for NgxLinkifyjs configuration
+ */
 const NgxLinkifyjsConfigToken = new InjectionToken('NgxLinkifyjsConfig');
+/**
+ * Default configuration for NgxLinkifyjs
+ */
 const DEFAULT_CONFIG = { enableHash: true, enableMention: true };
+
 // Conditionally import plugins based on configuration
 let pluginsLoaded = false;
 function loadPlugins(config) {
-    if (pluginsLoaded)
+    if (pluginsLoaded) {
         return;
+    }
+    const pluginPromises = [];
     if (config?.enableHash) {
-        import('linkify-plugin-hashtag').catch(err => console.error('Failed to load hashtag plugin:', err));
+        pluginPromises.push(import('linkify-plugin-hashtag').catch(err => {
+            console.error('Failed to load hashtag plugin:', err);
+            return null;
+        }));
     }
     if (config?.enableMention) {
-        import('linkify-plugin-mention').catch(err => console.error('Failed to load mention plugin:', err));
+        pluginPromises.push(import('linkify-plugin-mention').catch(err => {
+            console.error('Failed to load mention plugin:', err);
+            return null;
+        }));
     }
-    pluginsLoaded = true;
-}
-class NgxLinkifyjsModule {
-    static forRoot(config = DEFAULT_CONFIG) {
-        loadPlugins(config);
-        return {
-            ngModule: NgxLinkifyjsModule,
-            providers: [
-                NgxLinkifyjsService,
-                {
-                    provide: NgxLinkifyjsConfigToken,
-                    useValue: config
-                }
-            ]
-        };
+    if (pluginPromises.length > 0) {
+        Promise.all(pluginPromises).finally(() => {
+            pluginsLoaded = true;
+        });
+    }
+    else {
+        pluginsLoaded = true;
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.9", ngImport: i0, type: NgxLinkifyjsModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
-    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "20.3.9", ngImport: i0, type: NgxLinkifyjsModule, imports: [NgxLinkifyjsPipe], exports: [NgxLinkifyjsPipe] }); }
-    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "20.3.9", ngImport: i0, type: NgxLinkifyjsModule }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.9", ngImport: i0, type: NgxLinkifyjsModule, decorators: [{
-            type: NgModule,
-            args: [{
-                    imports: [NgxLinkifyjsPipe],
-                    exports: [NgxLinkifyjsPipe]
-                }]
-        }] });
+/**
+ * Provides NgxLinkifyjs services and configuration.
+ * Works with both standalone and NgModule-based applications.
+ *
+ * @param config - Configuration options for enabling hashtag and mention plugins
+ * @returns EnvironmentProviders array that can be used in app.config.ts
+ *
+ * @example
+ * ```typescript
+ * import { provideNgxLinkifyjs } from 'ngx-linkifyjs';
+ *
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [
+ *     provideNgxLinkifyjs({
+ *       enableHash: true,
+ *       enableMention: true
+ *     })
+ *   ]
+ * };
+ * ```
+ */
+function provideNgxLinkifyjs(config = DEFAULT_CONFIG) {
+    loadPlugins(config);
+    return makeEnvironmentProviders([
+        NgxLinkifyjsService,
+        {
+            provide: NgxLinkifyjsConfigToken,
+            useValue: { ...DEFAULT_CONFIG, ...config }
+        }
+    ]);
+}
 
 /*
  * Public API Surface of ngx-linkifyjs
@@ -113,5 +152,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.9", ngImpor
  * Generated bundle index. Do not edit.
  */
 
-export { DEFAULT_CONFIG, LinkType, NgxLinkifyjsConfigToken, NgxLinkifyjsModule, NgxLinkifyjsPipe, NgxLinkifyjsService };
+export { DEFAULT_CONFIG, LinkType, NgxLinkifyjsConfigToken, NgxLinkifyjsPipe, NgxLinkifyjsService, provideNgxLinkifyjs };
 //# sourceMappingURL=code-name-jack-ngx-linkifyjs.mjs.map

package/fesm2022/code-name-jack-ngx-linkifyjs.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"code-name-jack-ngx-linkifyjs.mjs","sources":["../../../projects/ngx-linkifyjs-v2/src/lib/enum/linktype.enum.ts","../../../projects/ngx-linkifyjs-v2/src/lib/pipes/ngx-linkifyjs.pipe.ts","../../../projects/ngx-linkifyjs-v2/src/lib/service/ngx-linkifyjs.service.ts","../../../projects/ngx-linkifyjs-v2/src/lib/ngx-linkifyjs.module.ts","../../../projects/ngx-linkifyjs-v2/src/public-api.ts","../../../projects/ngx-linkifyjs-v2/src/code-name-jack-ngx-linkifyjs.ts"],"sourcesContent":["export enum LinkType {\n  URL = 'url',\n  HASHTAG = 'hashtag',\n  MENTION = 'mention',\n  EMAIL = 'email',\n}\n","import {Pipe, PipeTransform} from '@angular/core';\nimport {NgxLinkifyOptions} from '../interfaces/ngx-linkifyjs.interface';\nimport linkifyStr from 'linkify-string';\n\n@Pipe({\n  name: 'linkify',\n  standalone: true\n})\nexport class NgxLinkifyjsPipe implements PipeTransform {\n\n  transform(value: string, options?: NgxLinkifyOptions): string {\n    return value ? linkifyStr(value, options) : value;\n  }\n\n}\n","import {Injectable} from '@angular/core';\nimport * as linkify from 'linkifyjs';\nimport linkifyStr from 'linkify-string';\nimport {Link, NgxLinkifyOptions} from '../interfaces/ngx-linkifyjs.interface';\n\n@Injectable()\nexport class NgxLinkifyjsService {\n  constructor() {\n  }\n\n  /**\n   * Convert the passed text as a string to an appropriate url\n   *\n   * @param text - the string to convert\n   * @param options - options to pass it to the linkifyjs library\n   */\n  linkify(text: string, options?: NgxLinkifyOptions): string {\n    return linkifyStr(text, options);\n  }\n\n  /**\n   * Find any links in a given text as a string\n   *\n   * @param text - the string to find some links\n   */\n  find(text: string): Array<Link> {\n    return linkify.find(text);\n  }\n\n  /**\n   * Test if a given value is a link or an array of all links\n   *\n   * @param value - the value to test\n   */\n  test(value: string | string[]): boolean {\n    if (typeof value === 'string') {\n      return linkify.test(value);\n    }\n    return value.find(v => !linkify.test(v)) === undefined;\n  }\n\n}\n","import {InjectionToken, ModuleWithProviders, NgModule} from '@angular/core';\n\nimport {NgxLinkifyjsService} from './service/ngx-linkifyjs.service';\nimport {NgxLinkifyjsPipe} from './pipes/ngx-linkifyjs.pipe';\n\n// Export module's public API\nexport {Link} from './interfaces/ngx-linkifyjs.interface';\nimport {NgxLinkifyjsConfig} from './interfaces/ngx-linkifyjs.interface';\n\nexport {LinkType} from './enum/linktype.enum';\nexport {NgxLinkifyOptions} from './interfaces/ngx-linkifyjs.interface';\nexport {NgxLinkifyjsPipe} from './pipes/ngx-linkifyjs.pipe';\nexport {NgxLinkifyjsService} from './service/ngx-linkifyjs.service';\n\nexport const NgxLinkifyjsConfigToken = new InjectionToken<NgxLinkifyjsConfig>('NgxLinkifyjsConfig');\nexport const DEFAULT_CONFIG: NgxLinkifyjsConfig = {enableHash: true, enableMention: true};\n\n// Conditionally import plugins based on configuration\nlet pluginsLoaded = false;\n\nfunction loadPlugins(config: NgxLinkifyjsConfig) {\n  if (pluginsLoaded) return;\n  \n  if (config?.enableHash) {\n    import('linkify-plugin-hashtag').catch(err => console.error('Failed to load hashtag plugin:', err));\n  }\n\n  if (config?.enableMention) {\n    import('linkify-plugin-mention').catch(err => console.error('Failed to load mention plugin:', err));\n  }\n  \n  pluginsLoaded = true;\n}\n\n@NgModule({\n  imports: [NgxLinkifyjsPipe],\n  exports: [NgxLinkifyjsPipe]\n})\nexport class NgxLinkifyjsModule {\n\n  static forRoot(config: NgxLinkifyjsConfig = DEFAULT_CONFIG): ModuleWithProviders<NgxLinkifyjsModule> {\n    loadPlugins(config);\n    \n    return {\n      ngModule: NgxLinkifyjsModule,\n      providers: [\n        NgxLinkifyjsService,\n        {\n          provide: NgxLinkifyjsConfigToken,\n          useValue: config\n        }\n      ]\n    };\n  }\n\n}\n","/*\n * Public API Surface of ngx-linkifyjs\n */\n\nexport * from './lib/enum/linktype.enum';\nexport * from './lib/interfaces/ngx-linkifyjs.interface';\nexport * from './lib/pipes/ngx-linkifyjs.pipe';\nexport * from './lib/service/ngx-linkifyjs.service';\nexport * from './lib/ngx-linkifyjs.module';\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":";;;;;IAAY;AAAZ,CAAA,UAAY,QAAQ,EAAA;AAClB,IAAA,QAAA,CAAA,KAAA,CAAA,GAAA,KAAW;AACX,IAAA,QAAA,CAAA,SAAA,CAAA,GAAA,SAAmB;AACnB,IAAA,QAAA,CAAA,SAAA,CAAA,GAAA,SAAmB;AACnB,IAAA,QAAA,CAAA,OAAA,CAAA,GAAA,OAAe;AACjB,CAAC,EALW,QAAQ,KAAR,QAAQ,GAAA,EAAA,CAAA,CAAA;;MCQP,gBAAgB,CAAA;IAE3B,SAAS,CAAC,KAAa,EAAE,OAA2B,EAAA;AAClD,QAAA,OAAO,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,KAAK;IACnD;8GAJW,gBAAgB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,IAAA,EAAA,CAAA,CAAA;4GAAhB,gBAAgB,EAAA,YAAA,EAAA,IAAA,EAAA,IAAA,EAAA,SAAA,EAAA,CAAA,CAAA;;2FAAhB,gBAAgB,EAAA,UAAA,EAAA,CAAA;kBAJ5B,IAAI;AAAC,YAAA,IAAA,EAAA,CAAA;AACJ,oBAAA,IAAI,EAAE,SAAS;AACf,oBAAA,UAAU,EAAE;AACb,iBAAA;;;MCDY,mBAAmB,CAAA;AAC9B,IAAA,WAAA,GAAA;IACA;AAEA;;;;;AAKG;IACH,OAAO,CAAC,IAAY,EAAE,OAA2B,EAAA;AAC/C,QAAA,OAAO,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC;IAClC;AAEA;;;;AAIG;AACH,IAAA,IAAI,CAAC,IAAY,EAAA;AACf,QAAA,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;IAC3B;AAEA;;;;AAIG;AACH,IAAA,IAAI,CAAC,KAAwB,EAAA;AAC3B,QAAA,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;AAC7B,YAAA,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;QAC5B;AACA,QAAA,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS;IACxD;8GAjCW,mBAAmB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA;kHAAnB,mBAAmB,EAAA,CAAA,CAAA;;2FAAnB,mBAAmB,EAAA,UAAA,EAAA,CAAA;kBAD/B;;;MCSY,uBAAuB,GAAG,IAAI,cAAc,CAAqB,oBAAoB;AAC3F,MAAM,cAAc,GAAuB,EAAC,UAAU,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI;AAExF;AACA,IAAI,aAAa,GAAG,KAAK;AAEzB,SAAS,WAAW,CAAC,MAA0B,EAAA;AAC7C,IAAA,IAAI,aAAa;QAAE;AAEnB,IAAA,IAAI,MAAM,EAAE,UAAU,EAAE;AACtB,QAAA,OAAO,wBAAwB,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,GAAG,CAAC,CAAC;IACrG;AAEA,IAAA,IAAI,MAAM,EAAE,aAAa,EAAE;AACzB,QAAA,OAAO,wBAAwB,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,GAAG,CAAC,CAAC;IACrG;IAEA,aAAa,GAAG,IAAI;AACtB;MAMa,kBAAkB,CAAA;AAE7B,IAAA,OAAO,OAAO,CAAC,MAAA,GAA6B,cAAc,EAAA;QACxD,WAAW,CAAC,MAAM,CAAC;QAEnB,OAAO;AACL,YAAA,QAAQ,EAAE,kBAAkB;AAC5B,YAAA,SAAS,EAAE;gBACT,mBAAmB;AACnB,gBAAA;AACE,oBAAA,OAAO,EAAE,uBAAuB;AAChC,oBAAA,QAAQ,EAAE;AACX;AACF;SACF;IACH;8GAfW,kBAAkB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,QAAA,EAAA,CAAA,CAAA;+GAAlB,kBAAkB,EAAA,OAAA,EAAA,CAHnB,gBAAgB,CAAA,EAAA,OAAA,EAAA,CAChB,gBAAgB,CAAA,EAAA,CAAA,CAAA;+GAEf,kBAAkB,EAAA,CAAA,CAAA;;2FAAlB,kBAAkB,EAAA,UAAA,EAAA,CAAA;kBAJ9B,QAAQ;AAAC,YAAA,IAAA,EAAA,CAAA;oBACR,OAAO,EAAE,CAAC,gBAAgB,CAAC;oBAC3B,OAAO,EAAE,CAAC,gBAAgB;AAC3B,iBAAA;;;ACrCD;;AAEG;;ACFH;;AAEG;;;;"}
+{"version":3,"file":"code-name-jack-ngx-linkifyjs.mjs","sources":["../../../projects/ngx-linkifyjs-v2/src/lib/enum/linktype.enum.ts","../../../projects/ngx-linkifyjs-v2/src/lib/pipes/ngx-linkifyjs.pipe.ts","../../../projects/ngx-linkifyjs-v2/src/lib/service/ngx-linkifyjs.service.ts","../../../projects/ngx-linkifyjs-v2/src/lib/constants/ngx-linkifyjs.constants.ts","../../../projects/ngx-linkifyjs-v2/src/lib/providers/ngx-linkifyjs.provider.ts","../../../projects/ngx-linkifyjs-v2/src/public-api.ts","../../../projects/ngx-linkifyjs-v2/src/code-name-jack-ngx-linkifyjs.ts"],"sourcesContent":["export enum LinkType {\n  URL = 'url',\n  HASHTAG = 'hashtag',\n  MENTION = 'mention',\n  EMAIL = 'email',\n}\n","import { Pipe, PipeTransform } from '@angular/core';\nimport { NgxLinkifyOptions } from '../interfaces/ngx-linkifyjs.interface';\nimport linkifyStr from 'linkify-string';\n\n@Pipe({\n  name: 'linkify',\n  standalone: true\n})\nexport class NgxLinkifyjsPipe implements PipeTransform {\n  transform(value: string | null | undefined, options?: NgxLinkifyOptions): string {\n    if (!value) {\n      return '';\n    }\n    return linkifyStr(value, options);\n  }\n}\n","import { Injectable } from '@angular/core';\nimport * as linkify from 'linkifyjs';\nimport linkifyStr from 'linkify-string';\nimport { Link, NgxLinkifyOptions } from '../interfaces/ngx-linkifyjs.interface';\n\n@Injectable({ providedIn: 'root' })\nexport class NgxLinkifyjsService {\n  /**\n   * Convert the passed text as a string to an appropriate url\n   *\n   * @param text - the string to convert\n   * @param options - options to pass it to the linkifyjs library\n   * @returns HTML string with linkified URLs, emails, hashtags, and mentions\n   */\n  linkify(text: string, options?: NgxLinkifyOptions): string {\n    if (!text) {\n      return '';\n    }\n    return linkifyStr(text, options);\n  }\n\n  /**\n   * Find any links in a given text as a string\n   *\n   * @param text - the string to find some links\n   * @returns Array of Link objects found in the text\n   */\n  find(text: string): Link[] {\n    if (!text) {\n      return [];\n    }\n    return linkify.find(text);\n  }\n\n  /**\n   * Test if a given value is a link or an array of all links\n   *\n   * @param value - the value to test (string or array of strings)\n   * @returns true if all values are valid links, false otherwise\n   */\n  test(value: string | readonly string[]): boolean {\n    if (typeof value === 'string') {\n      return linkify.test(value);\n    }\n    return value.every(v => linkify.test(v));\n  }\n}\n","import { InjectionToken } from '@angular/core';\nimport { NgxLinkifyjsConfig } from '../interfaces/ngx-linkifyjs.interface';\n\n/**\n * Injection token for NgxLinkifyjs configuration\n */\nexport const NgxLinkifyjsConfigToken = new InjectionToken<NgxLinkifyjsConfig>('NgxLinkifyjsConfig');\n\n/**\n * Default configuration for NgxLinkifyjs\n */\nexport const DEFAULT_CONFIG: NgxLinkifyjsConfig = { enableHash: true, enableMention: true };\n\n","import { EnvironmentProviders, makeEnvironmentProviders } from '@angular/core';\nimport { NgxLinkifyjsService } from '../service/ngx-linkifyjs.service';\nimport { NgxLinkifyjsConfig } from '../interfaces/ngx-linkifyjs.interface';\nimport { NgxLinkifyjsConfigToken, DEFAULT_CONFIG } from '../constants/ngx-linkifyjs.constants';\n\n// Conditionally import plugins based on configuration\nlet pluginsLoaded = false;\n\nfunction loadPlugins(config: NgxLinkifyjsConfig): void {\n  if (pluginsLoaded) {\n    return;\n  }\n  \n  const pluginPromises: Promise<unknown>[] = [];\n\n  if (config?.enableHash) {\n    pluginPromises.push(\n      import('linkify-plugin-hashtag').catch(err => {\n        console.error('Failed to load hashtag plugin:', err);\n        return null;\n      })\n    );\n  }\n\n  if (config?.enableMention) {\n    pluginPromises.push(\n      import('linkify-plugin-mention').catch(err => {\n        console.error('Failed to load mention plugin:', err);\n        return null;\n      })\n    );\n  }\n\n  if (pluginPromises.length > 0) {\n    Promise.all(pluginPromises).finally(() => {\n      pluginsLoaded = true;\n    });\n  } else {\n    pluginsLoaded = true;\n  }\n}\n\n/**\n * Provides NgxLinkifyjs services and configuration.\n * Works with both standalone and NgModule-based applications.\n * \n * @param config - Configuration options for enabling hashtag and mention plugins\n * @returns EnvironmentProviders array that can be used in app.config.ts\n * \n * @example\n * ```typescript\n * import { provideNgxLinkifyjs } from 'ngx-linkifyjs';\n * \n * export const appConfig: ApplicationConfig = {\n *   providers: [\n *     provideNgxLinkifyjs({\n *       enableHash: true,\n *       enableMention: true\n *     })\n *   ]\n * };\n * ```\n */\nexport function provideNgxLinkifyjs(\n  config: NgxLinkifyjsConfig = DEFAULT_CONFIG\n): EnvironmentProviders {\n  loadPlugins(config);\n  \n  return makeEnvironmentProviders([\n    NgxLinkifyjsService,\n    {\n      provide: NgxLinkifyjsConfigToken,\n      useValue: { ...DEFAULT_CONFIG, ...config }\n    }\n  ]);\n}\n\n","/*\n * Public API Surface of ngx-linkifyjs\n */\n\nexport * from './lib/enum/linktype.enum';\nexport * from './lib/interfaces/ngx-linkifyjs.interface';\nexport * from './lib/pipes/ngx-linkifyjs.pipe';\nexport * from './lib/service/ngx-linkifyjs.service';\nexport * from './lib/providers/ngx-linkifyjs.provider';\nexport * from './lib/constants/ngx-linkifyjs.constants';\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":";;;;;IAAY;AAAZ,CAAA,UAAY,QAAQ,EAAA;AAClB,IAAA,QAAA,CAAA,KAAA,CAAA,GAAA,KAAW;AACX,IAAA,QAAA,CAAA,SAAA,CAAA,GAAA,SAAmB;AACnB,IAAA,QAAA,CAAA,SAAA,CAAA,GAAA,SAAmB;AACnB,IAAA,QAAA,CAAA,OAAA,CAAA,GAAA,OAAe;AACjB,CAAC,EALW,QAAQ,KAAR,QAAQ,GAAA,EAAA,CAAA,CAAA;;MCQP,gBAAgB,CAAA;IAC3B,SAAS,CAAC,KAAgC,EAAE,OAA2B,EAAA;QACrE,IAAI,CAAC,KAAK,EAAE;AACV,YAAA,OAAO,EAAE;QACX;AACA,QAAA,OAAO,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC;IACnC;8GANW,gBAAgB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,IAAA,EAAA,CAAA,CAAA;4GAAhB,gBAAgB,EAAA,YAAA,EAAA,IAAA,EAAA,IAAA,EAAA,SAAA,EAAA,CAAA,CAAA;;2FAAhB,gBAAgB,EAAA,UAAA,EAAA,CAAA;kBAJ5B,IAAI;AAAC,YAAA,IAAA,EAAA,CAAA;AACJ,oBAAA,IAAI,EAAE,SAAS;AACf,oBAAA,UAAU,EAAE;AACb,iBAAA;;;MCDY,mBAAmB,CAAA;AAC9B;;;;;;AAMG;IACH,OAAO,CAAC,IAAY,EAAE,OAA2B,EAAA;QAC/C,IAAI,CAAC,IAAI,EAAE;AACT,YAAA,OAAO,EAAE;QACX;AACA,QAAA,OAAO,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC;IAClC;AAEA;;;;;AAKG;AACH,IAAA,IAAI,CAAC,IAAY,EAAA;QACf,IAAI,CAAC,IAAI,EAAE;AACT,YAAA,OAAO,EAAE;QACX;AACA,QAAA,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;IAC3B;AAEA;;;;;AAKG;AACH,IAAA,IAAI,CAAC,KAAiC,EAAA;AACpC,QAAA,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;AAC7B,YAAA,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;QAC5B;AACA,QAAA,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1C;8GAvCW,mBAAmB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA;AAAnB,IAAA,SAAA,IAAA,CAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,QAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,mBAAmB,cADN,MAAM,EAAA,CAAA,CAAA;;2FACnB,mBAAmB,EAAA,UAAA,EAAA,CAAA;kBAD/B,UAAU;mBAAC,EAAE,UAAU,EAAE,MAAM,EAAE;;;ACFlC;;AAEG;MACU,uBAAuB,GAAG,IAAI,cAAc,CAAqB,oBAAoB;AAElG;;AAEG;AACI,MAAM,cAAc,GAAuB,EAAE,UAAU,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI;;ACNzF;AACA,IAAI,aAAa,GAAG,KAAK;AAEzB,SAAS,WAAW,CAAC,MAA0B,EAAA;IAC7C,IAAI,aAAa,EAAE;QACjB;IACF;IAEA,MAAM,cAAc,GAAuB,EAAE;AAE7C,IAAA,IAAI,MAAM,EAAE,UAAU,EAAE;AACtB,QAAA,cAAc,CAAC,IAAI,CACjB,OAAO,wBAAwB,CAAC,CAAC,KAAK,CAAC,GAAG,IAAG;AAC3C,YAAA,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,GAAG,CAAC;AACpD,YAAA,OAAO,IAAI;QACb,CAAC,CAAC,CACH;IACH;AAEA,IAAA,IAAI,MAAM,EAAE,aAAa,EAAE;AACzB,QAAA,cAAc,CAAC,IAAI,CACjB,OAAO,wBAAwB,CAAC,CAAC,KAAK,CAAC,GAAG,IAAG;AAC3C,YAAA,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,GAAG,CAAC;AACpD,YAAA,OAAO,IAAI;QACb,CAAC,CAAC,CACH;IACH;AAEA,IAAA,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;QAC7B,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,MAAK;YACvC,aAAa,GAAG,IAAI;AACtB,QAAA,CAAC,CAAC;IACJ;SAAO;QACL,aAAa,GAAG,IAAI;IACtB;AACF;AAEA;;;;;;;;;;;;;;;;;;;;AAoBG;AACG,SAAU,mBAAmB,CACjC,MAAA,GAA6B,cAAc,EAAA;IAE3C,WAAW,CAAC,MAAM,CAAC;AAEnB,IAAA,OAAO,wBAAwB,CAAC;QAC9B,mBAAmB;AACnB,QAAA;AACE,YAAA,OAAO,EAAE,uBAAuB;AAChC,YAAA,QAAQ,EAAE,EAAE,GAAG,cAAc,EAAE,GAAG,MAAM;AACzC;AACF,KAAA,CAAC;AACJ;;AC3EA;;AAEG;;ACFH;;AAEG;;;;"}

package/index.d.ts

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { PipeTransform, InjectionToken, ModuleWithProviders } from '@angular/core';
+import { PipeTransform, EnvironmentProviders, InjectionToken } from '@angular/core';
 
 declare enum LinkType {
     URL = "url",
@@ -18,60 +18,85 @@ interface NgxLinkifyjsConfig {
     enableMention?: boolean;
 }
 interface NgxLinkifyOptions {
-    attributes?: any;
+    attributes?: Record<string, string | number | boolean>;
     className?: string;
     defaultProtocol?: string;
-    events?: any;
-    ignoreTags?: Array<any>;
+    events?: Record<string, (event: Event) => void>;
+    ignoreTags?: string[];
     nl2br?: boolean;
     tagName?: string;
     target?: {
         url: string;
     };
     validate?: boolean;
-    format?(value: any, type: any): any;
-    formatHref?(href: any, type: any): any;
+    format?: (value: string, type: string) => string;
+    formatHref?: (href: string, type: string) => string;
 }
 
 declare class NgxLinkifyjsPipe implements PipeTransform {
-    transform(value: string, options?: NgxLinkifyOptions): string;
+    transform(value: string | null | undefined, options?: NgxLinkifyOptions): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<NgxLinkifyjsPipe, never>;
     static ɵpipe: i0.ɵɵPipeDeclaration<NgxLinkifyjsPipe, "linkify", true>;
 }
 
 declare class NgxLinkifyjsService {
-    constructor();
     /**
      * Convert the passed text as a string to an appropriate url
      *
      * @param text - the string to convert
      * @param options - options to pass it to the linkifyjs library
+     * @returns HTML string with linkified URLs, emails, hashtags, and mentions
      */
     linkify(text: string, options?: NgxLinkifyOptions): string;
     /**
      * Find any links in a given text as a string
      *
      * @param text - the string to find some links
+     * @returns Array of Link objects found in the text
      */
-    find(text: string): Array<Link>;
+    find(text: string): Link[];
     /**
      * Test if a given value is a link or an array of all links
      *
-     * @param value - the value to test
+     * @param value - the value to test (string or array of strings)
+     * @returns true if all values are valid links, false otherwise
      */
-    test(value: string | string[]): boolean;
+    test(value: string | readonly string[]): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<NgxLinkifyjsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<NgxLinkifyjsService>;
 }
 
+/**
+ * Provides NgxLinkifyjs services and configuration.
+ * Works with both standalone and NgModule-based applications.
+ *
+ * @param config - Configuration options for enabling hashtag and mention plugins
+ * @returns EnvironmentProviders array that can be used in app.config.ts
+ *
+ * @example
+ * ```typescript
+ * import { provideNgxLinkifyjs } from 'ngx-linkifyjs';
+ *
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [
+ *     provideNgxLinkifyjs({
+ *       enableHash: true,
+ *       enableMention: true
+ *     })
+ *   ]
+ * };
+ * ```
+ */
+declare function provideNgxLinkifyjs(config?: NgxLinkifyjsConfig): EnvironmentProviders;
+
+/**
+ * Injection token for NgxLinkifyjs configuration
+ */
 declare const NgxLinkifyjsConfigToken: InjectionToken<NgxLinkifyjsConfig>;
+/**
+ * Default configuration for NgxLinkifyjs
+ */
 declare const DEFAULT_CONFIG: NgxLinkifyjsConfig;
-declare class NgxLinkifyjsModule {
-    static forRoot(config?: NgxLinkifyjsConfig): ModuleWithProviders<NgxLinkifyjsModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgxLinkifyjsModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxLinkifyjsModule, never, [typeof NgxLinkifyjsPipe], [typeof NgxLinkifyjsPipe]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<NgxLinkifyjsModule>;
-}
 
-export { DEFAULT_CONFIG, LinkType, NgxLinkifyjsConfigToken, NgxLinkifyjsModule, NgxLinkifyjsPipe, NgxLinkifyjsService };
+export { DEFAULT_CONFIG, LinkType, NgxLinkifyjsConfigToken, NgxLinkifyjsPipe, NgxLinkifyjsService, provideNgxLinkifyjs };
 export type { Link, NgxLinkifyOptions, NgxLinkifyjsConfig };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@code-name-jack/ngx-linkifyjs",
   "description": "Angular wrapper for linkifyjs(v4) -  library for finding links in plain text and converting them to HTML <a> tags via linkifyjs",
-  "version": "20.0.1",
+  "version": "20.1.0",
   "homepage": "https://github.com/code-name-jack/ngx-linkifyjs-v2",
   "author": {
     "name": "Code Name Jack",