npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@angular-material-extensions/algolia

v0.1.0

Published

Angular Library that enhances algolia instant search library - Material UI components and general services and directives

Downloads

7

Readme

@angular-material-extensions/algolia - Angular Library that enhances algolia instant search library - Material UI components and general services and directives

npm version npm demo Join the chat at https://gitter.im/angular-material-extensions/Lobby Coverage Status Build Status CircleCI branch dependency Status devDependency Status Greenkeeper Badge license

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

If did you like this project, support angular-material-extensions by starring :star: and sharing it :loudspeaker:

Table of Contents

Demo

View all the directives and components in action at https://angular-material-extensions.github.io/algolia

Dependencies

  • Angular (requires Angular 2 or higher | we are using already V9 ;)

for the directive as standalone you just need to install the following packages

  • "algoliasearch": "^3.35.1",
  • "angular-instantsearch": "^3.0.0-beta.5",
  • "instantsearch.js": "^4.7.0",
  • "@types/algoliasearch": "^3.34.10"
npm install algoliasearch@3 angular-instantsearch@beta instantsearch.js@3

npm install --save-dev @types/algoliasearch

Installation

1. Install via ng add. (Recommended)

If Angular Material Design is not setup, just run ng add @angular/material learn more

Now add the library via the angular schematics and everything will be setup for you

ng add @angular-material-extensions/algolia

2. Install via npm. (Alternative)

Now install @angular-material-extensions/algolia via:

npm install --save @angular-material-extensions/algolia

Requirements (peer dependencies):

for the ui input component, please consider to install the following packages

npm i @angular/cdk @angular/material @angular/animations  

Additional requirements Theme (Material Design)


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/algolia:

{
  '@angular-material-extensions/algolia';: 'node_modules/@angular-material-extensions/algolia/bundles/algolia.umd.js',
}

Once installed you need to import the main module:

import { MatAlgoliaModule } from '@angular-material-extensions/algolia';

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 MatAlgoliaModule.forRoot()):

import { MatAlgoliaModule } from '@angular-material-extensions/algolia';

@NgModule({
  declarations: [AppComponent, ...],
  imports: [
     // important !!!
     
     MatAlgoliaModule, ...],  
  bootstrap: [AppComponent]
})
export class AppModule {
}

Usage

Components

Directives

add matAlgoliaRefresh to a button component in order to trigger a refresh mechanism via algolia api automatically

<button mat-icon-button matAlgoliaRefresh matTooltip="Aktualisieren">
    <mat-icon>refresh</mat-icon>
</button>

API - for more info please visit the official documentation Maps JavaScript API

mat-algolia-menu-select

| option | bind | type | default | description | |:-------------------|:--------:|:------:|:------------:|:-------------------------------------------------------------------------------------------------|
| attribute | Input() | string ; | - | key to filter

Documentation

Please checkout the full documentation here

Run Demo App Locally

$ git clone https://github.com/angular-material-extensions/algolia.git
  • build the library

  • serve the demo app

Development

  1. clone this repo
  2. Install the dependencies by running npm i
  3. go to lib directory under projects/angular-material-extensions/algolia
  4. build the library npm run build

Other Angular Libraries

Support

Built by and for developers :heart: we will help you :punch:

License

Copyright (c) 2020 Anthony Nahas. Licensed under the MIT License (MIT)