Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

angular-last-fm-scrobbles

rameezv157GPL-3.0-only9.0.2TypeScript support: included

Angular component to display a user's recently scrobbled and currently playing tracks

last.fm, music, angular, scrobble

readme

Last.fm Scrobbles Widget

A widget to display a Last.fm user's recently scrobbled tracks, as well as the currently playing track if there is one.

Demo

Screenshot

A live demo can be seen on my personal website.

Usage

Setup

Using the component

  • In your Angular module, import the LastFmScrobblesModule:

    import { LastFmScrobblesModule } from 'angular-last-fm-scrobbles';

  • Add the last-fm-scrobbles component to your template:

    <last-fm-scrobbles username="bigtreeworld" [apiKey]="lastFmApiKey" theme="white" accentColor="BF40BFBF40BF"></last-fm-scrobbles>

    • The component has 2 required inputs:
      • username: a string containing the user's last.fm username
      • apiKey: a string containing your Last.fm API Key. If you don't have one yet, visit the Last.fm API account creation page and get one. It's really fast and simple.
    • Spotify integration can be enabled by passing values into the following inputs:
      • spotifyClientId: a string with your client ID
      • spotifyClientSecret: string with your client secret
      • Visit https://developer.spotify.com/dashboard to get your own client id and secret
      • This will enable preview clips and Spotify links
    • Theming: the following optional inputs allow for theming the widget:
      • accentColor takes a color in hex form. This is used for backgrounds/highlights and the equalizer. Defaults to '#FF6E6E'.
      • theme can be set to either 'black' (default) or 'white' which will change the widget colour scheme.
      • backgroundColor takes a color in hex form. Set this to a custom colour if this widget is beign used on a background that is not #000000 for the black theme and #ffffff for the white theme.
  • A sans-serif font style is recommended

Upcoming additions:

  • Tests
  • Music streaming links for tracks
  • Configurable number of tracks
  • Configurable refresh rate
  • Deduping tracks (especially the most recent track)
  • Your feature here - if you have any ideas, please feel free to contribute or make a feature request by opening an issue on GitHub

Build

Run ng build last-fm-scrobbles --configuration production to build the project. The build artifacts will be stored in the dist/ directory.

Publishing

After building your library with ng build last-fm-scrobbles, go to the dist folder cd dist/last-fm-scrobbles and run npm publish.