Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/angular-material-extensions/link-preview
Angular open source UI library to preview web links
https://github.com/angular-material-extensions/link-preview
angular angular-library library links material material-design material-extensions peview preview-links render-links ui web-links
Last synced: about 2 months ago
JSON representation
Angular open source UI library to preview web links
- Host: GitHub
- URL: https://github.com/angular-material-extensions/link-preview
- Owner: angular-material-extensions
- License: mit
- Created: 2018-07-22T21:29:04.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-10T22:34:15.000Z (over 2 years ago)
- Last Synced: 2024-07-11T14:34:30.558Z (2 months ago)
- Topics: angular, angular-library, library, links, material, material-design, material-extensions, peview, preview-links, render-links, ui, web-links
- Language: JavaScript
- Homepage: https://angular-material-extensions.github.io/link-preview
- Size: 10.9 MB
- Stars: 57
- Watchers: 5
- Forks: 18
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-angular-components - angular-material-extensions/link-preview - Angular open source UI library to preview web links (UI Components / Link Preview)
README
# @angular-material-extensions/link-preview - Angular open source UI library to preview web links powered by ngx-linkifyjs and material design
[](https://badge.fury.io/js/%40angular-material-extensions%2Flink-preview)
[](https://angular-material-extensions.github.io/link-preview)
[](https://gitter.im/angular-material-extensions/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://circleci.com/gh/angular-material-extensions/link-preview)
[](https://travis-ci.org/angular-material-extensions/link-preview)
[](https://coveralls.io/github/angular-material-extensions/link-preview?branch=master)
[](https://david-dm.org/angular-material-extensions/link-preview)
[](https://david-dm.org/angular-material-extensions/link-preview#info=devDependencies)
[](https://greenkeeper.io/)
[](https://github.com/angular-material-extensions/link-preview/blob/master/LICENSE)
[](https://github.com/gdi2290/awesome-angular)
multiple link preview
## Built by and for developers :heart:
Do you have any question or suggestion ? Please do not hesitate to contact us!
Alternatively, provide a PR | open an appropriate issue [here](https://github.com/angular-material-extensions/link-preview/issues)
If did you like this project, support [angular-material-extensions](https://github.com/angular-material-extensions)
by starring :star: and sharing it :loudspeaker:
## Table of Contents
- [Demo](#demo)
- [Dependencies](#dependencies)
- [Peer Dependencies](#peerDependencies)
- [Additional Requirements - material (Include a theme)](#additional-requirements-material-theme)
- [Installation](#installation)
- [Usage](#usage)
- [Documentation](#documentation)
- [Run Demo App Locally](#run-demo-app-locally)
- [Development](#development)
- [Other Angular Libraries](#other-angular-libraries)
- [Support](#support)
- [License](#license)
## [Demo](https://angular-material-extensions.github.io/link-preview)
View all the directives and components in action at [https://angular-material-extensions.github.io/link-preview](https://angular-material-extensions.github.io/link-preview)
## Dependencies
* [Angular](https://angular.io) (*requires* Angular 2 or higher, tested with V7)
## Requirements (peer dependencies):
- [angular animations v7.x](https://www.npmjs.com/package/@angular/animations)
- [angular http v7.x](https://www.npmjs.com/package/@angular/http)
- [angular cdk v7.x](https://www.npmjs.com/package/@angular/cdk)
- [angular material v7.x](https://www.npmjs.com/package/@angular/material)
- [angular material theme](https://material.angular.io/guide/getting-started#step-4-include-a-theme)
```bash
npm i @angular/cdk @angular/material @angular/animations @angular/http
```
or use `angular schematics` like e.g:
```bash
ng add @angular/material
```
---
### Additional requirements Theme (Material Design)
- [angular material theme](https://material.angular.io/guide/getting-started#step-4-include-a-theme)
## Installation
Install above dependencies via *npm*.
Now install `@angular-material-extensions/link-preview` via:
```shell
npm install --save @angular-material-extensions/link-preview
```
---
##### SystemJS
>**Note**:If you are using `SystemJS`, you should adjust your configuration to point to the UMD bundle.
In your systemjs config file, `map` needs to tell the System loader where to look for `@angular-material-extensions/link-preview`:
```js
map: {
'@angular-material-extensions/link-preview': 'node_modules/@angular-material-extensions/link-preview/bundles/link-preview.umd.js',
}
```
---
Once installed you need to import the main module:
```js
import { MatLinkPreviewModule } from '@angular-material-extensions/link-preview';
```
The only remaining part is to list the imported module in your application module. The exact method will be slightly
different for the root (top-level) module for which you should end up with the code similar to (notice ` MatLinkPreviewModule .forRoot()`):
```js
import { MatLinkPreviewModule } from '@angular-material-extensions/link-preview';
@NgModule({
declarations: [AppComponent, ...],
imports: [MatLinkPreviewModule.forRoot(), ...],
bootstrap: [AppComponent]
})
export class AppModule {
}
```
Other modules in your application can simply import ` MatLinkPreviewModule `:
```js
import { MatLinkPreviewModule } from '@angular-material-extensions/link-preview';
@NgModule({
declarations: [OtherComponent, ...],
imports: [MatLinkPreviewModule, ...],
})
export class OtherModule {
}
```
## Usage
### Directives
#### `matLinkPreview` used to find and parse links from any text input - should be used in combination with `` to render and preview the found links
e.g:
```html
Enter here your text here with few links to preview ;)
```
### Components
#### `` the container that hold the links to preview
| option | bind | type | default | description |
|:-------------------|:--------:|:------:|:------------:|:-------------------------------------------------------------------------------------------------|
| color | `Input()` | `string` | `primary` | the color to use for the button of the url - options --> `primary | accent | warn`
| multiple | `Input()` | `boolean` | `false` | whether to find, parse and render one single or multiple links
| showLoadingsProgress| `Input()` | `boolean` | `true` | whether to show and render a loading spinner while fetching the link to preview
e.g:
```html
```
#### Full example code
```html
Enter here your text here with few links to preview ;)
```
---
## [Documentation](https://angular-material-extensions.github.io/link-preview/doc/index.html)
Please checkout the full documentation [here](https://angular-material-extensions.github.io/link-preview/doc/index.html)
## Run Demo App Locally
- [clone this repo](https://github.com/angular-material-extensions/link-preview.git) by running
```bash
$ git clone https://github.com/angular-material-extensions/link-preview.git
```
- setup the **@angular-material-extensions/link-preview** package
```bash
$ gulp setup
```
- navigate to the demo app directory
```bash
$ cd demo
```
- install the dependencies and run the app
```bash
$ npm i && npm start
```
- the app is now hosted by `http://localhost:4200/`
## Development
1. clone this [repo](https://github.com/angular-material-extensions/link-preview.git)
2. Install the dependencies by running `npm i`
3. setup the library `gulp setup`
4. Navigate to the demo app's directory
- `cd demo`
_ `npm i && npm start`
---
## Other Angular Libraries
- [ngx-auth-firebaseui](https://github.com/AnthonyNahas/ngx-auth-firebaseui)
- [@firebaseui/ng-bootstrap](https://github.com/firebaseui/ng-bootstrap)
- [ngx-linkifyjs](https://github.com/AnthonyNahas/ngx-linkifyjs)
- [@angular-material-extensions/password-strength](https://github.com/angular-material-extensions/password-strength)
- [@angular-material-extensions/google-maps-autocomplete](https://github.com/angular-material-extensions/google-maps-autocomplete)
- [@angular-material-extensions/pages](https://github.com/angular-material-extensions/pages)
- [@angular-material-extensions/contacts](https://github.com/angular-material-extensions/contacts)
- [@angular-material-extensions/faq](https://github.com/angular-material-extensions/faq)
- [@angular-material-extensions/combination-generator](https://github.com/angular-material-extensions/combination-generator)
---
## Support
+ Drop an email to: [Anthony Nahas](mailto:[email protected])
+ or open an appropriate [issue](https://github.com/angular-material-extensions/link-preview/issues)
+ let us chat on [Gitter](https://gitter.im/angular-material-extensions/Lobby)
Built by and for developers :heart: we will help you :punch:
---
## License
Copyright (c) 2018 Anthony Nahas. Licensed under the MIT License (MIT)