Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 786 Bytes

README.md

File metadata and controls

54 lines (32 loc) · 786 Bytes
Raw

@britannica/compendium

React component library for Encyclopedia Britannica

Installation

$ npm install @britannica/compendium

Usage

import ReactDOM from 'react-dom';
import { MediaOverlay } from '@britannica/compendium';

ReactDOM.render(
  <MediaOverlay {...configurationProps} />,
  document.body,
);

Notes

  • Requires FontAwesome 5 Pro subscription. This must be configured at the project level. Read more
  • More documentation coming soon.

Components

  • LazyImage
  • MediaOverlay
  • MediaStrip
  • Shave
  • SnapSlider
  • Taparoo
  • Thumbnail

Hooks

  • useForm

Utilities

  • ContentfulUtils
  • FormUtils
  • RouteUtils

License

MIT.