Code Monkey home page Code Monkey logo

use-spotify's Introduction

use-spotify npm version

React hooks for the Spotify Web API.

Installation

yarn add use-spotify

npm install use-spotify

Usage

  1. Wrap your components with a SpotifyApiProvider and pass it a valid access token. Read the Spotify Authorization Guide for more details.
  2. Consume the useSpotify or useSpotifyLazy hooks.

API

Underneath the hood use-spotify utilizes Spotify Web API JS.

  • The first parameter to the hooks is any spotify method name.
  • The second parameter is options.
  • The third parameter is a list of arguments specific to the spotify method.

Further documentation for each method and its arguments can be found at the Spotify Web API JS documentation or in the Spotify Web API Reference.

const result = useSpotify(spotifyMethod, options, ...args)

const [invoke, result] = useSpotifyLazy(spotifyMethod, options, ...args)

await invoke()

await invoke(overrideOption, ...overrideArgs)

Examples

Provider

import { useSpotify, SpotifyApiProvider } from 'use-spotify';

const App = () => {
    return (
        <SpotifyApiProvider accessToken={'token goes here'}>
            <MyTopArtists/>
            <Search />
        </SpotifyApiProvider>
    );
};

Simple hook usage

import { useSpotify } from 'use-spotify';

const MyTopArtists = () => {
    const myTopArtists = useSpotify('getMyTopArtists');
    
    if (myTopArtists.loading) {
        return 'Loading';
    }
    
    return myTopArtists.data.artists.items.map(x => (
        <div key={x.id}>
            {x.name}
        </div>
    ))
}

Passing arguments to a hook

import { useSpotify } from 'use-spotify';

const Search = () => {
    const search = useSpotify(
        'search',
        {
            limit: 5,
        },
        'The National',
        ['artist', 'album']
    );

    if (search.loading) {
        return 'Loading';
    }

    return search.data.artists.items.map(x => (
        <div key={x.id}>
            {x.name}
        </div>
    ))
}

Passing arguments to a lazy hook

import { useSpotifyLazy } from 'use-spotify';

const SearchLazy = () => {
    const [search, results] = useSpotifyLazy(
        'search',
    );

    useEffect(() => {
        (async () => {
            const searchResults = await search(
                {
                    limit: 5,
                },
                'The National',
                ['artist', 'album']
            );
        })()
    }, [])
    
    if (results.loading) {
        return 'Loading';
    }

    return results.data.artists.items.map(x => (
        <div key={x.id}>
            {x.name}
        </div>
    ))
}

use-spotify's People

Contributors

timmikeladze avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.