Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

react-goodreads-shelf

build CodeQL Maintainability Rating Coverage

This React component allows you to display a public Goodreads shelf in a React application. It's a lot like the Goodreads JavaScript widget, but allows for more customization, better async loading, and React-like usage.

Example image

Installation

npm install --save react-goodreads-shelf

or

yarn add react-goodreads-shelf

Usage

import React from "react";
import { GoodreadsBookshelf } from "react-goodreads-shelf";

export default function App() {
	return (
		<GoodreadsBookshelf userId="USER_ID_HERE" />
	);
}

Customization

You can also set some options as supported by the Goodreads API:

Option Type Description Default Works Without API?
shelf string The shelf from which to fetch books read
sort string The order in which to sort the results returned date_read no
limit number The maximum number of books to be returned 10 sort of
width number Minimum width allowed for each book 100
search string Search text ""

Development

  • yarn start to watch changes and build
  • yarn storybook to launch storybook for testing

ToDo

Short-term plans include adding additional API options and styling

About

A React widget for displaying a user's public bookshelf

Topics

Resources

License

Packages

No packages published