{"id":13729599,"url":"https://github.com/angular-material-extensions/link-preview","last_synced_at":"2025-10-16T21:31:49.424Z","repository":{"id":57096990,"uuid":"141932037","full_name":"angular-material-extensions/link-preview","owner":"angular-material-extensions","description":"Angular open source UI library to preview web links","archived":false,"fork":false,"pushed_at":"2022-01-10T22:34:15.000Z","size":11432,"stargazers_count":58,"open_issues_count":40,"forks_count":18,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-16T19:38:17.114Z","etag":null,"topics":["angular","angular-library","library","links","material","material-design","material-extensions","peview","preview-links","render-links","ui","web-links"],"latest_commit_sha":null,"homepage":"https://angular-material-extensions.github.io/link-preview","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/angular-material-extensions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"angular-material-extensions","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":"npm/@angular-material-extensions/link-preview","community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":["https://github.com/AnthonyNahas","anahas.de"]}},"created_at":"2018-07-22T21:29:04.000Z","updated_at":"2024-11-18T15:34:00.000Z","dependencies_parsed_at":"2022-08-20T18:10:21.175Z","dependency_job_id":null,"html_url":"https://github.com/angular-material-extensions/link-preview","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular-material-extensions%2Flink-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular-material-extensions%2Flink-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular-material-extensions%2Flink-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular-material-extensions%2Flink-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/angular-material-extensions","download_url":"https://codeload.github.com/angular-material-extensions/link-preview/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236748986,"owners_count":19198618,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","angular-library","library","links","material","material-design","material-extensions","peview","preview-links","render-links","ui","web-links"],"created_at":"2024-08-03T02:01:02.804Z","updated_at":"2025-10-16T21:31:43.778Z","avatar_url":"https://github.com/angular-material-extensions.png","language":"JavaScript","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"angular-material-extensions's logo\"\n   height=\"256px\" width=\"256px\" style=\"text-align: center;\" \n   src=\"https://cdn.jsdelivr.net/gh/angular-material-extensions/link-preview/assets/angular-material-extensions-logo.png\"\u003e\n\u003c/p\u003e\n\n# @angular-material-extensions/link-preview - Angular open source UI library to preview web links powered by ngx-linkifyjs and material design\n\n[![npm version](https://badge.fury.io/js/%40angular-material-extensions%2Flink-preview.svg)](https://badge.fury.io/js/%40angular-material-extensions%2Flink-preview)\n[![npm demo](https://img.shields.io/badge/demo-online-ed1c46.svg)](https://angular-material-extensions.github.io/link-preview)\n[![Join the chat at https://gitter.im/angular-material-extensions/Lobby](https://badges.gitter.im/angular-material-extensions/Lobby.svg)](https://gitter.im/angular-material-extensions/Lobby?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n[![CircleCI branch](https://img.shields.io/circleci/project/github/angular-material-extensions/link-preview/master.svg?label=circleci)](https://circleci.com/gh/angular-material-extensions/link-preview)\n[![Build Status](https://travis-ci.org/angular-material-extensions/link-preview.svg?branch=master)](https://travis-ci.org/angular-material-extensions/link-preview)\n[![Coverage Status](https://coveralls.io/repos/github/angular-material-extensions/link-preview/badge.svg?branch=master)](https://coveralls.io/github/angular-material-extensions/link-preview?branch=master)\n[![dependency Status](https://david-dm.org/angular-material-extensions/link-preview/status.svg)](https://david-dm.org/angular-material-extensions/link-preview)\n[![devDependency Status](https://david-dm.org/angular-material-extensions/link-preview/dev-status.svg?branch=master)](https://david-dm.org/angular-material-extensions/link-preview#info=devDependencies)\n[![Greenkeeper Badge](https://badges.greenkeeper.io/angular-material-extensions/link-preview.svg)](https://greenkeeper.io/)\n[![license](https://img.shields.io/github/license/angular-material-extensions/link-preview.svg?style=flat-square)](https://github.com/angular-material-extensions/link-preview/blob/master/LICENSE)\n[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/gdi2290/awesome-angular)\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"@angular-material-extensions/link-preview demo\" width=\"500px\" style=\"text-align: center;\" \n  src=\"https://cdn.jsdelivr.net/gh/angular-material-extensions/link-preview/assets/demo1.gif\"\u003e\n\u003c/p\u003e\n\nmultiple link preview\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"@angular-material-extensions/link-preview demo with multiple preview\" width=\"70%\" style=\"text-align: center;\" \n  src=\"https://cdn.jsdelivr.net/gh/angular-material-extensions/link-preview/assets/demo.png\"\u003e\n\u003c/p\u003e\n\n\n## Built by and for developers :heart:\nDo you have any question or suggestion ? Please do not hesitate to contact us!\nAlternatively, provide a PR | open an appropriate issue [here](https://github.com/angular-material-extensions/link-preview/issues)\n\nIf did you like this project, support [angular-material-extensions](https://github.com/angular-material-extensions) \nby starring :star: and sharing it :loudspeaker:\n\n## Table of Contents\n- [Demo](#demo)\n- [Dependencies](#dependencies)\n- [Peer Dependencies](#peerDependencies)\n- [Additional Requirements - material (Include a theme)](#additional-requirements-material-theme)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Documentation](#documentation)\n- [Run Demo App Locally](#run-demo-app-locally)\n- [Development](#development)\n- [Other Angular Libraries](#other-angular-libraries)\n- [Support](#support)\n- [License](#license)\n\n\u003ca name=\"demo\"/\u003e\n\n## [Demo](https://angular-material-extensions.github.io/link-preview)\n\nView all the directives and components in action at [https://angular-material-extensions.github.io/link-preview](https://angular-material-extensions.github.io/link-preview)\n\n\u003ca name=\"dependencies\"/\u003e\n\n## Dependencies\n* [Angular](https://angular.io) (*requires* Angular 2 or higher, tested with V7)\n\n\u003ca name=\"peerDependencies\"/\u003e\n\n## Requirements (peer dependencies):\n- [angular animations v7.x](https://www.npmjs.com/package/@angular/animations)\n- [angular http v7.x](https://www.npmjs.com/package/@angular/http)\n- [angular cdk v7.x](https://www.npmjs.com/package/@angular/cdk)\n- [angular material v7.x](https://www.npmjs.com/package/@angular/material)\n\n- [angular material theme](https://material.angular.io/guide/getting-started#step-4-include-a-theme)\n\n```bash\nnpm i @angular/cdk @angular/material @angular/animations @angular/http \n```\n\nor use `angular schematics` like e.g:\n\n```bash\nng add @angular/material \n```\n\n---\n\n\u003ca name=\"additional-requirements-material-theme\"/\u003e\n\n### Additional requirements Theme (Material Design)\n- [angular material theme](https://material.angular.io/guide/getting-started#step-4-include-a-theme)\n\n## Installation\nInstall above dependencies via *npm*. \n\nNow install `@angular-material-extensions/link-preview` via:\n```shell\nnpm install --save @angular-material-extensions/link-preview\n```\n\n---\n##### SystemJS\n\u003e**Note**:If you are using `SystemJS`, you should adjust your configuration to point to the UMD bundle.\nIn your systemjs config file, `map` needs to tell the System loader where to look for `@angular-material-extensions/link-preview`:\n```js\nmap: {\n  '@angular-material-extensions/link-preview': 'node_modules/@angular-material-extensions/link-preview/bundles/link-preview.umd.js',\n}\n```\n---\n\nOnce installed you need to import the main module:\n```js\nimport { MatLinkPreviewModule } from '@angular-material-extensions/link-preview';\n```\nThe only remaining part is to list the imported module in your application module. The exact method will be slightly\ndifferent for the root (top-level) module for which you should end up with the code similar to (notice ` MatLinkPreviewModule .forRoot()`):\n```js\nimport { MatLinkPreviewModule } from '@angular-material-extensions/link-preview';\n\n@NgModule({\n  declarations: [AppComponent, ...],\n  imports: [MatLinkPreviewModule.forRoot(), ...],  \n  bootstrap: [AppComponent]\n})\nexport class AppModule {\n}\n```\n\nOther modules in your application can simply import ` MatLinkPreviewModule `:\n\n```js\nimport { MatLinkPreviewModule } from '@angular-material-extensions/link-preview';\n\n@NgModule({\n  declarations: [OtherComponent, ...],\n  imports: [MatLinkPreviewModule, ...], \n})\nexport class OtherModule {\n}\n```\n\n## Usage\n\n### Directives\n\n#### `matLinkPreview` used to find and parse links from any text input - should be used in combination with `\u003cmat-link-preview-container\u003e` to render and preview the found links\n\ne.g:\n\n```html\n\u003cmat-form-field class=\"demo-full-width\" appearance=\"outline\"\u003e\n  \u003cmat-label\u003eEnter here your text here with few links to preview ;)\u003c/mat-label\u003e\n  \u003ctextarea matInput matTextareaAutosize matLinkPreview minRows=\"6\"\u003e\u003c/textarea\u003e\n\u003c/mat-form-field\u003e\n```\n\n### Components\n\n#### `\u003cmat-link-preview-container\u003e` the container that hold the links to preview\n\n| option             | bind     |  type  |   default    | description  |\n|:-------------------|:--------:|:------:|:------------:|:-------------------------------------------------------------------------------------------------|    \n| color               | `Input()`  | `string`     |   `primary`  | the color to use for the \u003ca\u003e button of the url - options --\u003e `primary | accent | warn`\n| multiple            | `Input()`  | `boolean`    |   `false`   | whether to find, parse and render one single or multiple links\n| showLoadingsProgress| `Input()`  | `boolean`    |   `true`    | whether to show and render a loading spinner while fetching the link to preview\n\ne.g:\n\n```html\n\u003cmat-link-preview-container color=\"primary\" [multiple]=\"true\"\u003e\u003c/mat-link-preview-container\u003e\n```\n\n#### Full example code\n\n```html\n\u003cdiv class=\"container\" fxFlex.xs=\"100\" fxFlex.sm=\"70\" fxFlex=\"50\"\u003e\n    \u003cdiv fxLayout=\"column\" fxLayoutAlign=\"center\"\u003e\n\n     \u003c!-- here --\u003e\n      \u003cmat-form-field class=\"demo-full-width\" appearance=\"outline\"\u003e\n        \u003cmat-label\u003eEnter here your text here with few links to preview ;)\u003c/mat-label\u003e\n        \u003ctextarea matInput matTextareaAutosize matLinkPreview minRows=\"6\"\u003e\u003c/textarea\u003e\n        \u003cmat-link-preview-container [multiple]=\"true\"\u003e\u003c/mat-link-preview-container\u003e\n      \u003c/mat-form-field\u003e\n      \u003c!-- #### --\u003e\n      \n    \u003c/div\u003e\n\u003c/div\u003e\n```\n\n--- \n\n\u003ca name=\"documentation\"/\u003e\n\n## [Documentation](https://angular-material-extensions.github.io/link-preview/doc/index.html)\n\nPlease checkout the full documentation [here](https://angular-material-extensions.github.io/link-preview/doc/index.html) \n\n\n\u003ca name=\"run-demo-app-locally\"/\u003e\n\n## Run Demo App Locally\n\n- [clone this repo](https://github.com/angular-material-extensions/link-preview.git) by running\n```bash\n$ git clone https://github.com/angular-material-extensions/link-preview.git\n```\n\n- setup the **@angular-material-extensions/link-preview** package\n\n```bash\n$ gulp setup\n```\n\n- navigate to the demo app directory\n```bash\n$ cd demo\n```\n\n- install the dependencies and run the app\n```bash\n$ npm i \u0026\u0026 npm start\n```\n\n- the app is now hosted by `http://localhost:4200/`\n\n\n\u003ca name=\"development\"/\u003e\n\n## Development\n\n1. clone this [repo](https://github.com/angular-material-extensions/link-preview.git)\n2. Install the dependencies by running `npm i`\n3. setup the library `gulp setup`\n4. Navigate to the demo app's directory\n  - `cd demo`\n  _ `npm i \u0026\u0026 npm start`\n  \n  ---\n\n\n\u003ca name=\"other-angular-libraries\"/\u003e\n\n## Other Angular Libraries\n- [ngx-auth-firebaseui](https://github.com/AnthonyNahas/ngx-auth-firebaseui)\n- [@firebaseui/ng-bootstrap](https://github.com/firebaseui/ng-bootstrap)\n- [ngx-linkifyjs](https://github.com/AnthonyNahas/ngx-linkifyjs)\n- [@angular-material-extensions/password-strength](https://github.com/angular-material-extensions/password-strength)\n- [@angular-material-extensions/google-maps-autocomplete](https://github.com/angular-material-extensions/google-maps-autocomplete)\n- [@angular-material-extensions/pages](https://github.com/angular-material-extensions/pages)\n- [@angular-material-extensions/contacts](https://github.com/angular-material-extensions/contacts)\n- [@angular-material-extensions/faq](https://github.com/angular-material-extensions/faq)\n- [@angular-material-extensions/combination-generator](https://github.com/angular-material-extensions/combination-generator)\n\n---\n\n\n\u003ca name=\"support\"/\u003e\n\n## Support\n+ Drop an email to: [Anthony Nahas](mailto:anthony.na@hotmail.de)\n+ or open an appropriate [issue](https://github.com/angular-material-extensions/link-preview/issues)\n+ let us chat on [Gitter](https://gitter.im/angular-material-extensions/Lobby)\n \n Built by and for developers :heart: we will help you :punch:\n\n---\n\n\u003ca name=\"license\"/\u003e\n\n## License\n\nCopyright (c) 2018 Anthony Nahas. Licensed under the MIT License (MIT)\n\n","funding_links":["https://github.com/sponsors/angular-material-extensions","https://tidelift.com/funding/github/npm/@angular-material-extensions/link-preview","https://github.com/AnthonyNahas","anahas.de"],"categories":["UI Components"],"sub_categories":["Link Preview"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangular-material-extensions%2Flink-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fangular-material-extensions%2Flink-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangular-material-extensions%2Flink-preview/lists"}